InvenTree/CONTRIBUTING.md
2019-09-10 10:33:44 +10:00

746 B

Contributions to InvenTree are welcomed - please follow the guidelines below.

Feature Branches

No pushing to master! New featues must be submitted in a separate branch (one branch per feature).

Testing

Any new code should be covered by unit tests - a submitted PR may not be accepted if the code coverage is decreased.

Documentation

New features or updates to existing features should be accompanied by user documentation. A PR with associated documentation should link to the matching PR at https://github.com/inventree/InvenTree.github.io

Code Style

Sumbitted Python code is automatically checked against PEP style guidelines. Locally you can run make style to ensure the style checks will pass, before submitting the PR.