Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (30 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 1.17 KB
Raw

Contributing to PRIK

Thanks for helping make native Python interfaces easier to build.

Get started

Create a focused branch and install PRIK with its development tools:

python3 -m pip install -e ".[qa]"

Run the smallest relevant test while you work:

PYTHONPATH=. python3 -m pytest -q path/to/tests

Before opening a pull request

  • Add or update tests for changed behavior.
  • Update the user guide when the public API, CLI, or supported behavior changes.
  • Add user-visible changes to Unreleased in CHANGELOG.md.
  • Run Ruff and the relevant tests:
python3 -m ruff check .
python3 -m ruff format --check .
PYTHONPATH=. python3 -m pytest -q path/to/tests

Keep the pull request easy to review: explain the problem, the solution, and how you verified it. All required GitHub checks must pass before merge.

For the complete workflow, see the development guide and quality-assurance guide.

License

Contributions are accepted under the MIT License. By submitting a contribution, you confirm that you have the right to license it under those terms.