What problem does it solve?
It prevents malformed or inconsistent commit messages and pull request titles by enforcing RARA’s approved short conventional-title format.
Core Features & Use Cases
- Conventional subset enforcement: Restricts the title type to feat, fix, chore, or test and disallows unlisted types like docs/refactor/style by mapping guidance to allowed alternatives.
- Scope and subject formatting rules: Ensures correct structure (type: subject or type(scope): subject), keeps scope short and lower-case, and avoids trailing punctuation like a period.
- PR body template guidance: Produces PR descriptions in markdown with a clear summary, motivation, optional issue reference, and an acceptable testing line for documentation-only changes.
Use case: When preparing a PR for a UI workflow improvement, generate a title like fix(tui): keep approval overlay above transcript and follow it with a compliant PR body that clearly states motivation and validation.
Quick Start
Tell the agent to generate a GitHub commit title and PR title for the following change, following the RARA project-github-titles rules and using only the allowed types and formatting.