Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (20 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.36 KB

Contributing

Thank you for considering contributing to python-benedict!

Reporting bugs

Please open a GitHub issue with:

  • A minimal reproducible example.
  • The Python version and python-benedict version you are using.
  • The expected vs. actual behaviour.

Warning

If the bug is a security vulnerability, please do not open a public issue. Follow the Security Policy instead.

Suggesting features

Open a GitHub issue labelled enhancement describing your use case and the proposed API.

How to contribute

  1. Fork the repository and create your branch from main.
  2. Make your changes — add tests that cover any new behaviour or bug fix.
  3. Run the test suite — see the Testing section for full details.
  4. Open a Pull Request against main with a clear description of what you changed and why, and reference the related issue.

Code style

This project uses Ruff for linting and formatting, and mypy for static type checking. All checks are enforced via pre-commit hooks.

License

By contributing you agree that your contributions will be licensed under the MIT License.