This document explains how, technically, to contribute to this project. A code of conduct may be available in the root of this repository, or included in the readme.
- Check the issues and draft pull requests to see if anyone is working on something similar.
- Make a branch for your contribution.
- Implement your feature, bug fix, documentation, etc.
In pycharm:
- Add any new files to
git(i.e. stage them):
- Commit the changes (with a sensible message).
Add / commit multiple times to break your contribution into easy to follow chunks.
- Push your changes:
- Add any new files to
- Make a pull request against the
masterbranch of this repository.
You are advised to make a draft pull request as soon as you start work so nobody else ends up working on the same thing.
- There is no coding style.
- PEP8 is the preferred coding style, but is not mandated.
- Code must be PEP8 compliant.
- There is no preferred style for documentation, but documentation is required.
- PEP257 docstrings are required.
- Sphinx docstrings are required.
- Do not use typehints.
- Typehints are optional, but encouraged.
- Typehints are required.
- The
pytestframework is used and tests are encouraged. - Code must be covered by unit tests. The
pytestframework is used.
- Use
pylintto analyse your code before submission.