1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
|
# Contributor Guide
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:
- [Source Code](https://github.com/dfm/corner.py)
- [Documentation](https://corner.readthedocs.io)
- [Issue Tracker](https://github.com/dfm/corner.py/issues)
## How to report a bug
Report bugs on the [Issue Tracker](https://github.com/dfm/corner.py/issues).
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](https://stackoverflow.com/help/minimal-reproducible-example).
## How to request a feature
Feel free to request features on the [Issue
Tracker](https://github.com/dfm/corner.py/issues).
## How to set up your development environment
TODO
## How to test the project
```bash
python -m pip install nox
python -m nox
```
## How to submit changes
Open a [Pull Request](https://github.com/dfm/corner.py/pulls).
|