Contribute.md

Django Ledger Contribution Guidelines

• UI
  • Django Ledger UI is based on the Bulma CSS Framework via WebPack. Any template contributions must follow Bulma's best practices.
  • Icons are implemented through Iconify and Django Ledger has the built-in template tag icon which can be used to render any icon using Iconify.
• JavaScript
  • Django Ledger uses TypeScript to ship JavaScript to the browser. Webpack is used to bundle all CSS/JS into two javascript files respectively. See bundle in the static file directory. The build command in the assets/package.json file will build styles and javascript and automatically update the application bundle with the latest compiled version.
• Models
  • Changes and contributions to Models are limited to those with proven Django experience. Also, in addition to Django experience, some accounting and domain knowledge is required. Changes to models must be justified and susbtantiated with proper accounting best practices.
• Documentation
  • All documentation contributions are welcome. Sphinx has been set up to automatically generate static HTML documentation.
• Unit Tests
  • All unit tests contributions are welcome if they are intended to validate program logic and/or accounting logic.