PR_RULES.md

PR Rules

This file defines the minimum requirements for opening a pull request against this repository.

Before Opening a PR

1. Keep the PR scoped to a single change or closely related set of changes.
2. Make sure the branch is up to date with the target branch.
3. Run the relevant tests locally and confirm they pass.
4. Include documentation updates when behavior, APIs, or developer workflows change.
5. Do not open a draft-quality PR unless the title clearly marks it as Draft.

PR Description Requirements

Every PR must include:

1. A short summary of what changed.
2. A clear reason for the change.
3. Testing details:
   • What you ran
   • What passed
   • What was not tested
4. Any risks, limitations, or follow-up work.
5. References to related issues, tickets, or discussions when applicable.

Required PR Comment

After opening the PR, the author must leave a comment on the PR with the following information:

Summary:
- <what changed>

Validation:
- <tests/checks run>

Notes:
- <known risks, blockers, or follow-up items>

Replace the placeholders with project-specific details. Do not leave this comment blank or generic. changed.

Quality Bar

1. Keep commits and diffs readable.
2. Avoid unrelated refactors in the same PR.
3. Call out breaking changes explicitly.
4. If a test is missing for a bug fix or new behavior, explain why.