Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
16 lines (11 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

16 lines (11 loc) · 1.25 KB
Raw

Contributing

Thank you for improving Open Code Review Toolkit. Keep changes focused, add regression tests for behavior changes, and use synthetic examples only.

Participation in this project is governed by the Code of Conduct. Report conduct incidents through its private enforcement route rather than a public issue.

  1. Create a branch from main.
  2. Install the locked development environment with uv sync --frozen.
  3. Update PLANS.md for substantial work.
  4. Add a Towncrier fragment for user-visible changes.
  5. Run the checks in docs/development.md.
  6. Open a pull request; protected main accepts changes only through green pull requests.

Every non-release merge publishes a development build for the current .next-version line to TestPyPI. Stable releases use a repository-owned release/vX.Y.Z branch and an exact Release vX.Y.Z pull-request title; merging that reviewed PR authorizes the automated TestPyPI, PyPI, and GitHub Release chain.

Do not include real credentials, provider payloads, internal hosts, or private repository details. Security reports should follow SECURITY.md, while conduct incidents follow CODE_OF_CONDUCT.md; neither belongs in a public issue.