Thank you for investing your time in contributing to our project! ✨.
Read our Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
For small changes to the code or documentation (e.g. correcting a typo), please feel free to open a pull request directly.
For anything more significant, it is really helpful to open an issue first, to put it on the project's radar and facilitate discussion.
In the Issues section, it is possible to choose between -Bug report-, -Custom issue template- or -Feature request-, choose the one that feels more apporpiate.
Once a pull request is marked as ready and approved, it will get merged automatically. The automatic merge process will also (try to) ensure the branch is up to date with master, but on occasion you may need to intervene to make sure.
When preparing your branch for a pull request, it would be awesome if you took the time to clean up the history, and in general we prefer that you have kept up to date with master by rebasing as often as necessary.
For Python, we use Spyder's Autopep8 to format the code for conformance to the PEP 8 convention. We use the Numpy conventions for our docstrings style.