Contributing#
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in the ways listed below.
Report Bugs#
Report bugs using Gitlab issues.
If you are reporting a bug, please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Fix Bugs#
Look through the Gitlab issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Implement Features#
Look through the Gitlab issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Submit Feedback#
The best way to send feedback is to file an issue on Gitlab.
If you are proposing a feature:
Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started#
Ready to contribute? Here’s how to set up this project for local development.
Clone this repo locally.
Install your local copy into a virtualenv, e.g., using
conda.Create a branch for local development and make changes locally.
Commit your changes and push your branch to the repo.
Submit a merge request for your branch through the Gitlab website.
Code of Conduct#
Please note that this project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.