Our project welcomes external contributions. If you have an itch, please feel free to scratch it.
To contribute code or documentation, please submit a pull request.
A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the issue tracker. These will be marked with the good first issue label. You may also want to look at those marked with help wanted.
Note: We appreciate your effort, and want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in backlog for a long time, or cannot be accepted at all!
If you would like to implement a new feature, please raise an issue before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base.
If you would like to fix a bug, please raise an issue before sending a pull request so it can be tracked.
We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution. We use the same approach - the Developer's Certificate of Origin 1.1 (DCO) - that the Linux® Kernel community uses to manage code contributions.
We simply ask that when submitting a patch for review, the developer must include a sign-off statement in the commit message.
Here is an example Signed-off-by line, which indicates that the submitter accepts the DCO:
Signed-off-by: John Doe <[email protected]>
You can include this automatically when you commit a change to your local git repository using the following command:
git commit -sPlease feel free to connect with us on our Ryver forum. You can join the Ryver community here.
This project follows the standard packaging way:
# Install requirements
python -m pip install -r requirements.txt
# Build
python setup.py build
# Install
python setup.py installThis package uses pytest for its tests. You can run them like so:
# Test installed package (python setup.py install)
python -m pytest tests
# Test local changes which haven't been installed
PYTHONPATH=src python -m pytest testsThis project will attempt to follow PEP 8 guidelines. New contributions should enforce PEP-8 style and we welcome any changes (see issue #19 for more details)