feat: add conventional commits support to finishing-a-development-branch #136
Conversation
- Update PR template to include conventional commit title format - Add Change Type checklist with semantic versioning impact - Add Breaking Changes section for MAJOR version bumps - Add quick reference table for conventional commit prefixes - Include examples for common commit types Closes obra#135 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
WalkthroughDocumentation update to the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
skills/finishing-a-development-branch/SKILL.md (1)
100-109: Version impact mappings are accurate and spec-compliant.The Change Type section correctly maps conventional commit prefixes to semantic versioning bumps per the Conventional Commits spec and aligns with standard-version/semantic-release behavior. All critical types are included.
One optional improvement: the Breaking Changes section could provide slightly more guidance (e.g., "Describe what breaks and migration path") to help contributors understand what to document.
If desired, enhance line 109 with more actionable guidance:
-<!-- If this is a breaking change, describe what breaks and migration path --> +<!-- If this is a breaking change, describe what breaks and the migration path for users -->This makes it clearer what information is needed without adding length.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
skills/finishing-a-development-branch/SKILL.md(2 hunks)
🔇 Additional comments (3)
skills/finishing-a-development-branch/SKILL.md (3)
95-114: Template structure and gh command syntax are correct.The PR template correctly implements the conventional commit format and integrates well with the existing options flow. The heredoc syntax properly preserves the template while allowing dynamic title injection. HTML comments effectively guide contributors without cluttering the submitted PR body.
172-190: Reference section is well-structured, spec-compliant, and includes quality examples.The new "Conventional Commits for PR Titles" section provides clear guidance with an accurate prefix table and realistic, domain-specific examples. The section reinforces the PR template structure and supports the skill's integration with automated versioning tools.
1-230: Excellent enhancement that fully addresses the stated objectives.This documentation update successfully adds conventional commit guidance to the finishing-a-development-branch skill. The changes are well-integrated, spec-compliant, and provide practical value for contributors:
- ✓ PR template is updated with conventional commit format
- ✓ Version impact mappings are accurate and comprehensive
- ✓ Breaking changes are properly documented
- ✓ Reference section provides clear, scannable guidance
- ✓ Integration with standard-version/semantic-release is seamless
The documentation is clear without being verbose, and the examples are realistic and instructive. No correctness issues or conflicts with existing content identified.
1 participant
Summary
finishing-a-development-branchskill to use conventional commit title formatCloses #135
Change Type
feat:- New feature (MINOR: x.X.0)Breaking Changes
N/A - This is an additive enhancement to the existing skill.
Test Plan
Context
This enhancement addresses the feature request in #135 to help guide contributors toward proper conventional commit conventions without requiring project-specific PR templates. The changes integrate well with automated tools like
standard-versionandsemantic-release.🤖 Generated with Claude Code
Summary by CodeRabbit
<type>: <description>.✏️ Tip: You can customize this high-level summary in your review settings.