Contributor’s Guide¶
Contributions are always welcome and greatly appreciated!
Code contributions¶
We love pull requests from everyone! Here’s a quick guide to improve the code:
Fork the repository and clone the fork.
Create a virtual environment using your tool of choice (e.g.
virtualenv
,conda
, etc).Install development dependencies:
pip install -r requirements.txt
pip install -r requirements-test.txt
Make sure all tests pass:
python setup.py test
Start making your changes to the master branch (or branch off of it).
Make sure all tests still pass:
python setup.py test
Add yourself to
AUTHORS.rst
.Commit your changes and push your branch to GitHub.
Create a pull request through the GitHub website.
Documentation improvements¶
We could always use more documentation, whether as part of the introduction/examples/usage documentation or API documentation in docstrings.
Documentation is written in reStructuredText and use Sphinx to generate the HTML output.
Once you made the documentation changes locally, run the documentation generation:
python setup.py build_sphinx
Bug reports¶
When reporting a bug please include:
Operating system name and version.
affo-email-service version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.