Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

46 lines (36 loc) · 2.14 KB
Raw

Contributing

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

Project setup

  1. Fork and clone the repo
  2. Checkout the development branch, which contains the latest changes
  3. Look at the projects README.md to run the application (running with docker is reccomended)
  4. Create a branch for your PR with git checkout -b pr/your-branch-name
  5. 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 run git pull. Then you can make all of your pull request branches based on this dev branch. Whenever you want to update your version of dev, do a regular git pull.

Committing and Pushing changes

  • 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.

Help needed

Please checkout the the open issues

Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!