If you want to contribute to Zookeeper and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on GitHub, new technologies and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.
- Create a personal fork of the project on GitHub.
- Clone the fork on your local machine via the commandline instructions below. Your remote repo on GitHub is called
origin. - Add the original repository as a remote called
upstream. - If you created your fork a while ago be sure to pull upstream changes into your local repository.
- Create a new branch to work on! Branch from
main. - Implement/fix your feature, comment your code.
- Follow the code style of the project, including indentation.
- Use the following command to test your changes:
pytest .
- Write or adapt tests as needed.
- Add or change the documentation as needed.
- Push your branch to your fork on Github, the remote
origin. - From your fork open a pull request in the correct branch. Target the project's
mainbranch. - Wait for approval.
- Once the pull request is approved and merged you can pull the changes from
upstreamto your local repo and delete your extra branch(es).
And last but not least: Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.
We use black to format all of our code. We recommend installing it as a plugin for your favorite code editor.
-
Increment the version number in
setup.py, and make a PR with that change. -
Wait until your PR is reviewed and merged.
-
Go to the GitHub releases, edit the release notes of the draft release, change the tag to the desired version (e.g.
v0.7.0) and hit "Publish release". -
A GitHub action will automatically publish a release to PyPI based on the tag.