3b75d900f6
* Added: Sphinx configuration including readthedocs config * Added: Sphinx fabric task to auto-document the project * Fixed: Some issues in the code causing autodoc to fail when parsing * Added: Manual docs - structure, proof of concepts and RsT examples * Fixed: RsT formatting in docstrings * Fixed: Some adjacent minor style and lint issues
34 lines
1.8 KiB
Markdown
34 lines
1.8 KiB
Markdown
## Repository contributions to the PyBitmessage project
|
|
|
|
- You can get paid for merged commits if you register at [Tip4Commit](https://tip4commit.com/github/Bitmessage/PyBitmessage)
|
|
|
|
### Code
|
|
|
|
- Try to refer to github issue tracker or other permanent sources of discussion about the issue.
|
|
- 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
|
|
|
|
### Documentation
|
|
|
|
- If there has been a change to the code, there's a good possibility there should be a corresponding change to the documentation
|
|
- If you can't run `fab build_docs` successfully, ask for someone to run it against your branch
|
|
|
|
### Tests
|
|
|
|
- If there has been a change to the code, there's a good possibility there should be a corresponding change to the tests
|
|
- If you can't run `fab tests` successfully, ask for someone to run it against your branch
|
|
|
|
## Translations
|
|
|
|
- For helping with translations, please use [Transifex](https://www.transifex.com/bitmessage-project/pybitmessage/).
|
|
- There is no need to submit pull requests for translations.
|
|
- For translating technical terms it is recommended to consult the [Microsoft Language Portal](https://www.microsoft.com/Language/en-US/Default.aspx).
|
|
|
|
### Gitiquette
|
|
|
|
- Make the pull request against the ["v0.6" branch](https://github.com/Bitmessage/PyBitmessage/tree/v0.6)
|
|
- PGP-sign the commits included in the pull request
|
|
- Use references to tickets, e.g. `addresses #123` or `fixes #234` in your commit messages
|
|
- Try to use a good editor that removes trailing whitespace, highlights potential python issues and uses unix line endings
|
|
- 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.
|
|
|