Thank you for your interest in improving this project. This project is open-source under the MIT 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. In particular, please include a Minimal, Reproducible Example.
How to request a feature#
Feel free to request features on the Issue Tracker.
How to test the project#
python -m pip install tox python -m tox
How to submit changes#
Open a Pull Request.
We use the towncrier package to manage
release notes, so you should include a “news fragment” in the
describing your changes. We’ll be happy to help on the pull request thread to
format that appropriately.
Making a new release#
These are the steps that need to be run when minting a new release:
Make sure that your local copy of main is up-to-date:
git pull origin main
Check out a new branch:
git checkout -b release
Update the release notes, using the version number that you’re going to bump to (try running with
python -m towncrier build --version THE_NEXT_VERSION
Open a PR with the new release notes and make sure that all the tests pass.
Make a release on GitHub (it’s good practice to make a release candidate first, just to be safe) with the appropriate version number.