Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1.85 KB
Raw

Contribution guidelines

Contributing to this project should be as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

GitHub is used for everything

GitHub is used to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase.

  1. Fork the repo and create a new branch from main.
  2. If you change something that's visible to other users, update the documentation.
  3. Test your contribution. Again. Once more.
  4. Issue a pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's issues

GitHub issues are used to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

Use Ruff to make sure the code follows the style.

License

By contributing, you agree that your contributions will be licensed under the MIT License. Please add your name and date of the contribution to the LICENSE file in the root of the repository as part of your contribution.