What problem does it solve?
Enforces a consistent, reviewer-friendly pull request format so reviewers can quickly understand what changed, why it changed, and how to validate it.
Core Features & Use Cases
- Title conventions: Use an optional semver prefix for version bumps, keep titles under 70 characters (excluding the prefix), and write in sentence case focused on user-facing changes.
- Structured body: Optionally include a Requirements GUID line, a Changes table summarizing observable behavioral changes, and a conditional Test plan only when manual testing is required.
- Review rules: Avoid implementation details and provenance statements, and focus on observable behavior to make reviews efficient and consistent.
- Use case: Use this when opening feature, bugfix, or release PRs to ensure reviewers can validate changes without ambiguity.
Quick Start
Create a pull request using the project's format: include the optional semver prefix in the title if applicable, add a Requirements GUID line when available, provide a Changes table describing observable behavior, and include a Test plan only when manual testing is required.