← Back to list

conventional-commit
by ramtinJ95
Manually managed dotfiles
⭐ 0🍴 0📅 Jan 18, 2026
SKILL.md
name: conventional-commit description: Create properly formatted conventional commits with type prefixes and optional scope
Conventional Commit Skill
Use this skill when creating git commits to ensure consistent, meaningful commit messages that follow the Conventional Commits specification.
Commit Message Format
<type>(<scope>): <subject>
<body>
<footer>
Required Elements
- type: The category of change (see types below)
- subject: Brief description in imperative mood ("add" not "added")
Optional Elements
- scope: Component or area affected (e.g.,
auth,api,ui) - body: Detailed explanation if needed
- footer: Breaking changes or issue references
Commit Types
| Type | Description | Example |
|---|---|---|
feat | New feature | feat(auth): add OAuth2 login |
fix | Bug fix | fix(api): handle null response |
docs | Documentation only | docs: update README installation |
style | Formatting, no code change | style: fix indentation in utils |
refactor | Code change, no new feature/fix | refactor(db): simplify query builder |
perf | Performance improvement | perf: cache expensive calculation |
test | Adding/fixing tests | test(auth): add login unit tests |
build | Build system or dependencies | build: upgrade typescript to 5.0 |
ci | CI configuration | ci: add GitHub Actions workflow |
chore | Maintenance tasks | chore: update .gitignore |
revert | Revert previous commit | revert: revert feat(auth) commit |
Rules
- Subject line: Max 70 characters, no period at end
- Imperative mood: "add feature" not "added feature" or "adds feature"
- Lowercase: Type and scope are lowercase
- Breaking changes: Add
!after type/scope and explain in footerfeat(api)!: change authentication flow BREAKING CHANGE: API now requires Bearer token instead of API key
Workflow
- Stage your changes:
git add <files> - Review what's staged:
git diff --cached - Determine the appropriate type based on the change
- Write commit message following the format
- Create the commit
Examples
Simple feature:
feat: add dark mode toggle
Bug fix with scope:
fix(auth): prevent session timeout on active users
Breaking change:
feat(api)!: migrate to v2 endpoints
BREAKING CHANGE: All v1 endpoints are now deprecated.
Migrate to /api/v2/* endpoints before next major release.
Closes #123
Multiple changes (prefer separate commits): If you have unrelated changes, create separate commits for each logical unit of work.
Todo List Integration
When working through implementation todos that modify code or files:
- Each completed implementation todo = one conventional commit
- After finishing an implementation task, stage and commit the changes
- Mark the todo as completed only AFTER the commit succeeds
This does NOT apply to:
- Research or exploration todos
- Planning or design todos
- Reading/reviewing code without changes
- Gathering information
Score
Total Score
50/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
○LICENSE
ライセンスが設定されている
0/10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
Reviews
💬
Reviews coming soon