From 927160c77f45811f8a1b8237544ccd4098390ee8 Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 10 Sep 2019 10:33:44 +1000 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..027d3641cb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +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.