Pull Request Standards
Overview
Standards for creating, reviewing, and merging pull requests. All pull requests must pass CI checks, receive at least one approving review, have no unresolved blocking comments, include tests for new features, and update documentation as needed. These rules keep the main branch stable and the review process predictable.
Rules
Write Clear PR Titles
Use the same type(scope): description format as commit messages. The title should be a concise summary of the change.
Correct
Incorrect
Write Complete PR Descriptions
Follow a consistent description structure so reviewers can quickly understand the change, verify it, and trace it back to an issue.
Correct
Follow Review Process
Authors and reviewers share responsibility for keeping PRs moving. Authors self-review before requesting feedback and respond within 24 hours. Reviewers provide constructive, timely reviews within 24-48 hours.
Use this checklist when reviewing:
Use Squash and Merge
All PRs use Squash and Merge as the merge strategy. This combines all commits into one, keeps main branch history clean, and preserves the PR discussion link.
Before merging, verify:
- All CI checks pass
- At least one approval
- No unresolved comments
- Branch is up to date with main