Contributor Guide#
Thank you for your interest in improving this project. This project is public domain under the CC0 1.0 Universal license and welcomes contributions in the form of bug reports, feature requests, and pull requests.
Here is a list of important resources for contributors:
How to report a bug#
Report bugs on the Issue Tracker.
When filing an issue, make sure to answer these questions:
Which operating system and Python version are you using?
Which version of this project are you using?
What did you do?
What did you expect to see?
What did you see instead?
The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.
How to request a feature#
Request features on the Issue Tracker.
How to set up your development environment#
You need Python 3.9+ and conda:
To setup a conda environment for developing:
From the root of the directory
conda env create -f environment.yml
conda activate gdptools
poetry install
pre-commit install --install-hooks
You are now ready to start developing.
How to test the project#
Run the full test suite:
nox
List the available Nox sessions:
nox --list-sessions
You can also run a specific Nox session. For example, invoke the unit test suite like this:
nox --session=tests
Unit tests are located in the tests directory, and are written using the pytest testing framework.
How to build the documentation#
nox -s docs-build
or to serve the documentation
nox -s docs
How to submit changes#
Open a merge request to submit changes to this project.
Your pull request needs to meet the following guidelines for acceptance:
The Nox test suite must pass without errors and warnings.
Include unit tests. This project maintains 100% code coverage.
If your changes add functionality, update the documentation accordingly.
Feel free to submit early, though—we can always iterate on this.
We use pre-commit
It is recommended to open an issue before starting work on anything. This will allow a chance to talk it over with the owners and validate your approach.