Conventional commit
Skill cuongtl1992/vibe-skills/skills/common/conventional-commit
Conventional Commits 1.0.0 format for consistent, parseable git commit messages. Use when committing changes, writing commit messages, or when the user mentions commit, save, git commit, or wants to persist work. Covers type selection, scope rules, description format, breaking changes, and multi-line commit workflow.From its SKILL.md
npx -y skills add cuongtl1992/vibe-skills --skill conventional-commitAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 11 stars11 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
3.0 KB, as published. Nobody here has run it
Conventional Commits
Structured commit messages following the Conventional Commits 1.0.0 specification.
Format
<type>(<scope>): <description>
[optional body]
[optional footer(s)]
Types
| Type | When | Example |
|---|---|---|
feat | New feature | feat(auth): add OAuth2 login |
fix | Bug fix | fix(cart): correct total calculation |
refactor | Code restructuring (no behavior change) | refactor(api): extract error handler |
docs | Documentation only | docs(readme): update setup instructions |
test | Adding or updating tests | test(order): add unit tests for checkout |
chore | Build, config, tooling | chore(deps): update Angular to v18 |
style | Formatting, semicolons (no logic) | style(lint): apply prettier formatting |
perf | Performance improvement | perf(query): add database index |
build | Build system changes | build(ci): update Node.js to v20 |
ci | CI/CD configuration | ci(github): add deploy workflow |
revert | Revert a previous commit | revert: undo feat(auth) OAuth changes |
Rules
- Description: lowercase, imperative mood, no period at end, max 72 characters
- Scope: optional but recommended, lowercase (module, component, or area)
- Breaking changes: Add
!after type/scope:feat(api)!: remove deprecated endpoint - Body: Separated by blank line, explains "what" and "why" (not "how")
- Footer:
BREAKING CHANGE: <description>orRefs: #123
Workflow
- Check status —
git statusto see what changed - Stage changes — Prefer
git add <file1> <file2>overgit add -A - Analyze changes — Determine type, scope, and description
- Compose message — Follow the format above
- Commit — Use HEREDOC for multi-line messages:
git commit -m "$(cat <<'EOF' feat(auth): add OAuth2 login flow Implements OAuth2 authorization code flow with PKCE. Adds login, callback, and token refresh endpoints. Refs: #142 EOF )" - Verify —
git log --oneline -1to confirm
For examples of good and bad commit messages, see references/commit-examples.md.