Thanks for being willing to contribute!
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
- Fork and clone the repo
- Checkout the development branch, which contains the latest changes
- Look at the projects
README.md
to run the application (running with docker is reccomended) - Create a branch for your PR with
git checkout -b pr/your-branch-name
- If you made some larger changes, please create an issue that documents the need for these changes and link it to the PR.
Tip: Keep your
dev
branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:git remote add upstream https://github.com/Provincie-Zuid-Holland/Omgevingsbeleid-API.git git fetch upstream git branch --set-upstream-to=upstream/dev dev
This will add the original repository as a "remote" called "upstream," Then fetch the git information from that remote, then set your local
dev
branch to use the upstream dev branch whenever you rungit pull
. Then you can make all of your pull request branches based on thisdev
branch. Whenever you want to update your version ofdev
, do a regulargit pull
.
- We strive to not let our test coverage go down. You can use Pytest to get the coverage report.
- If you implement new features please make sure that you have written tests.
- Also document code where needed. The format we use is documented in the sphinx docs.
- For code formatting we use PEP 8, make sure to use a linter.
Please checkout the the open issues
Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!