First of all, thank you for your interest in contributing to this tool. I am very happy you have decided to volunteer your help in making this piece of software better!
I losely follow PEP-8 and I am currently not doing type annotations. This might change in the future, but for now, please just try to stick to PEP-8 the most you can.
- Before opening a PR, check open PR's and issues to see if someone already has a solution for what you want to solve.
- Follow te code style guidelines.
- Make sure the PR title is capitalized, short (less than 50 chars) and concice.
- Make sure to update and add proper documentation
- No PR will be approved without sufficent unit tests, please add them!
- Target your PR to the
mainbranch
Once you have submitted a pull request, I will review it and I might propose changes and discuss your implementation. I will ultimately decide whether or not to incorporate your changes.
- Fork the repository and clone it locally.
Connect your local repository to the original
upstreamrepository by adding it as a remote. Pull in changes fromupstreamoften so that you stay up to date and so when you submit your pull request, merge conflicts will be less likely. See more detailed instructions here. - Create a branch for your edits.
- Contribute in the style of the project as outlined above. This makes it easier to review and understand. It also makes it easier to mantain in the future.
Once you’ve opened a pull request, a discussion will start around your proposed changes.
Other users may chime in, but ultimately the decision is made by me.
During the discussion, you may be asked to make some changes to your pull request.
If so, add more commits to your branch and push them – they will automatically go into the existing pull request. But don't forget to squash them (for a neater PR).
Thank you again for your interest in this project, and I look forward to hearing from you soon!