How to contribute to the project
Please follow the instructions below to find out how to best contribute to the project.
Register with buildbot
In order to contribute code, first please register your GitHub fork with the project's buildbot instance. This will then then execute all the code tests and builds that are currently available by just committing to your repository.
- Login to GitHub
- If you haven't done so yet, fork the PyBitmessage repository
- Visit the PyBitmessage Buildbot installation page
- Install it into your account and give it access to your "PyBitmessage" repository
Now, whenever you push code, you can check PyBitmessage Buildbot for the results of the tests. To find your repo's builds, navigate to "Builds" / "Last Changes" and at the top of your commit description, click on "See builds".
The tests are also run once you create a PR.
Pull request requirements
The best code contributions are pull requests on GitHub. Here are some rules to follow:
- try to explain what the code is about
- try to follow PEP0008
- make the pull request against the "v0.6" branch
- it should be possible to do a fast-forward merge of the pull requests. I.e. if possible, do a rebase of a pull request after another is merged ahead of yours. However, if it can be merged without having to manually resolve a conflict, that's acceptable as well.
- PGP-sign the commits included in the pull request, and make sure to upload your PGP key into your GitHub account
- You can get paid for merged commits if you register at Tip4Commit
If for some reason you don't want to use github, you can register with PyBitmessage Gitea, fork the latest archive of the project, and let us know which branch with the new code.
For helping with translations, please use Transifex. There is no need to submit pull requests for translations.
For translating technical terms it is recommended to consult the Microsoft Language Portal.