| name | git-commit-formatter |
| description | Conventional Commits 仕様に従って git のコミットメッセージを生成します。ユーザーが変更をコミットしたいときや、コミットメッセージの作成を求めたときに使用してください。 |
Git Commit Formatter Skill
Gitのコミットメッセージを作成する際は、必ず以下の Conventional Commits 仕様に従ってください。
また、コミットメッセージは必ず英語で記述すること。
フォーマット
<type>[optional scope]: <description>
使用可能な Type
- feat: A new feature(新機能)
- fix: A bug fix(バグ修正)
- docs: Documentation only changes(ドキュメントの変更のみ)
- style: Changes that do not affect the meaning of the code(コードの動作に影響しない修正:空白、フォーマット、セミコロンなど)
- refactor: A code change that neither fixes a bug nor adds a feature(リファクタリング)
- perf: A code change that improves performance(パフォーマンス改善)
- test: Adding missing tests or correcting existing tests(テストの追加・修正)
- chore: Changes to the build process or auxiliary tools and libraries(ビルドプロセスや補助ツールの変更)
指示事項
- 変更内容を分析し、最適な
type を選択すること。
- 必要に応じて、変更範囲を示す
scope を特定すること(例: 特定のコンポーネント名やファイル名)。
- 英語で 簡潔な
description を書くこと。その際、命令形(例: "add feature" とし、"added" や "adds" は避ける)を用いること。
- 破壊的変更がある場合は、フッターに
BREAKING CHANGE: で始まる説明を加えること。
出力例
feat(auth): implement login with google