1  ## Repository contributions to the PyBitmessage project
 2  
 3  ### Code
 4  
 5  - Try to refer to github issue tracker or other permanent sources of discussion about the issue.
 6  - It is clear from the diff *what* you have done, it may be less clear *why* you have done it so explain why this change is necessary rather than what it does.
 7  
 8  ### Documentation
 9  
10  Use `tox -e py27-doc` to build a local copy of the documentation.
11  
12  ### Tests
13  
14  - If there has been a change to the code, there's a good possibility there should be a corresponding change to the tests
15  - To run tests locally use `tox` or `./run-tests-in-docker.sh`
16  
17  ## Translations
18  
19  - For helping with translations, please use [Transifex](https://www.transifex.com/bitmessage-project/pybitmessage/).
20  - There is no need to submit pull requests for translations.
21  - For translating technical terms it is recommended to consult the [Microsoft Language Portal](https://www.microsoft.com/Language/en-US/Default.aspx).
22  
23  ### Gitiquette
24  
25  - Make the pull request against the ["v0.6" branch](https://github.com/Bitmessage/PyBitmessage/tree/v0.6)
26  - PGP-sign the commits included in the pull request
27  - Use references to tickets, e.g. `addresses #123` or `fixes #234` in your commit messages
28  - Try to use a good editor that removes trailing whitespace, highlights potential python issues and uses unix line endings
29  - If for some reason you don't want to use github, you can submit the patch using Bitmessage to the "bitmessage" chan, or to one of the developers.
30