Skip to content

Latest commit

 

History

History
83 lines (54 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

83 lines (54 loc) · 2.83 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 your branch from master.
  2. If you've changed something, update the documentation.
  3. Make sure your code passes lint checks (using pre-commit).
  4. Test your contribution.
  5. Issue that 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

Install uv and run uv sync to setup the developer environment. We use ruff and prettier to make sure the code follows the style.

pre-commit can be used to run all checks with one command (see dedicated section below).

Test your code modification

You can use the pre-commit settings implemented in this repository to have linting tools check your contributions (see dedicated section below).

When writing unittests please follow the good practises like:

  • Use faker to fake the data. See examples
  • Use mock to patch objects/methods. See examples

Pre-commit

With uv installed, run uv sync in the repo root. It will create a virtualenv with all required packages.

After that you can run pre-commit with settings included in the repository to have code style and linting checks.

Activate pre-commit git hook:

$ uvx pre-commit install

Now the pre-commit tests will be done every time you commit.

You can also run the tests on all repository files manually with this command:

$ uvx pre-commit run --all-files