What problem does it solve?
Enforce project hygiene throughout the PR lifecycle. Use before creating PRs to validate worktrees, branch naming, and issue linking. Use when creating PRs to ensure proper "Fixes #XYZ" keywords, conventional commit titles, and complete PR bodies. Use after PR merge for cleanup guidance and issue closure verification.
Core Features & Use Cases
- Pre-PR Validation: Ensure you are in a proper worktree, branch naming follows conventions, and the targeted issue is open.
- PR Body & Commits: Enforce "Fixes #XYZ" keywords and Conventional Emoji Commit conventions in PR titles and bodies.
- Lifecycle Guidance: Provide templates and checklists to support PR creation, review, and post-merge cleanup.
Quick Start
Before creating a PR, run the hygiene checks to validate:
- You are in a worktree (not main) and on a properly named branch containing i<num>.
- The issue number is valid and open.
- The PR body includes a Fixes #<issue> reference.
- Your commits reference the issue with a closing keyword (fixes, closes, resolves).
Example guidance:
- Verify you’re in a worktree (wip/ path)
- Confirm branch name contains i<number> (e.g., m8-p123-i234-feature)
- Ensure the linked issue is OPEN
- Ensure commits include a "Fixes #<num>" keyword