|
| 1 | +# Contribution guidelines |
| 2 | + |
| 3 | +Contributing to this project should be as easy and transparent as possible, whether it's: |
| 4 | + |
| 5 | +- Reporting a bug |
| 6 | +- Discussing the current state of the code |
| 7 | +- Submitting a fix |
| 8 | +- Proposing new features |
| 9 | + |
| 10 | +## GitHub is used for everything |
| 11 | + |
| 12 | +GitHub is used to host code, to track issues and feature requests, as well as accept pull requests. |
| 13 | + |
| 14 | +Pull requests are the best way to propose changes to the codebase. |
| 15 | + |
| 16 | +1. Fork the repo and create a new branch from `main`. |
| 17 | +2. If you change something that's visible to other users, update the documentation. |
| 18 | +4. Test your contribution. Again. Once more. |
| 19 | +5. Issue a pull request! |
| 20 | + |
| 21 | +## Any contributions you make will be under the MIT Software License |
| 22 | + |
| 23 | +In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. |
| 24 | + |
| 25 | +## Report bugs using GitHub's [issues](../../issues) |
| 26 | + |
| 27 | +GitHub issues are used to track public bugs. |
| 28 | +Report a bug by [opening a new issue](../../issues/new/choose); it's that easy! |
| 29 | + |
| 30 | +## Write bug reports with detail, background, and sample code |
| 31 | + |
| 32 | +**Great Bug Reports** tend to have: |
| 33 | + |
| 34 | +- A quick summary and/or background |
| 35 | +- Steps to reproduce |
| 36 | + - Be specific! |
| 37 | + - Give sample code if you can. |
| 38 | +- What you expected would happen |
| 39 | +- What actually happens |
| 40 | +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) |
| 41 | + |
| 42 | +People *love* thorough bug reports. I'm not even kidding. |
| 43 | + |
| 44 | +## Use a Consistent Coding Style |
| 45 | + |
| 46 | +Use [Ruff](https://docs.astral.sh/ruff/) to make sure the code follows the style. |
| 47 | + |
| 48 | +## License |
| 49 | + |
| 50 | +By contributing, you agree that your contributions will be licensed under the MIT License. |
| 51 | +Please add your name and date of the contribution to the `LICENSE` file in the root of the |
| 52 | +repository as part of your contribution. |
0 commit comments