git-commit-convention について
git-commit-conventionは、Conventional Commits 1.0.0形式でコミットを計画し、検証するためのエージェント向けスキルです。コミットの分割、メッセージ形式、バージョンへの影響、AIの貢献者表記を扱います。
主な機能
- 01変更全体に基づくコミット分割の計画
- 02ステージ済み変更とのメッセージ照合
- 03形式、タイプ、バージョンへの影響の説明
- 04破壊的変更とフッター構文への対応
- 05必要に応じたAI共同作成者の表記
活用シーン
- 01大きな変更を一貫性のあるコミットに分割
- 02ステージ済み差分に照らしてメッセージを確認
- 03破壊的変更と課題参照を記録
- 04コミットでエージェントの貢献を明記
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ edram/ skills --skill git-commit-conventionインストール後、Claude Code で/git-commit-conventionを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/core-format.mdcore-planning.mdcore-types.mdfeatures-ai-attribution.mdfeatures-breaking.mdfeatures-footers.md詳細
Conventional Commits 1.0.0 は、人が読みやすく、機械で解析できるコミットメッセージ形式を定義しています。メッセージを書く前に、変更セット全体をもとにコミットの境界を計画してください。複数回のやり取りで、すべてをまとめた1つのコミットではなく、まとまりのある複数のコミットができる場合もあります。仕様では、feat は MINOR、fix は PATCH、破壊的変更は MAJOR を意味します。それ以外のタイプとバージョンの対応付けは、プロジェクトごとの規約です。
- 必須なのは
typeとdescriptionのみで、それ以外はすべて任意です - スコープで影響範囲を絞り込みます:
feat(auth):、fix(api): - 破壊的変更には
!の接尾辞、またはBREAKING CHANGE:フッター(あるいは両方)を使用します - フッタートークンは Git のトレーラー規約に従います
- デフォルトは英語ですが、プロジェクトの既存の規約に合わせてください。
git logを確認し、最近のコミットで使われている言語に従ってください - コミットの境界は、やり取りの回数ではなく、目的と依存関係にもとづいて決めてください
- ステージされた差分と各メッセージを照合して検証してください。ステージされたすべての変更が記載された目的に沿っていること、また、重要な主張がすべて差分によって裏付けられていることを確認してください
- コミットを求められたら、作成する前にコミット案を提示してください。その後、ステージされた各コミットを個別に検証してください
<type>[optional scope][!]: <description>
[optional body]
[optional footer(s)]
コア
| トピック | 説明 | 参照 |
|---|---|---|
| コミット計画 | コミット前に変更を調査、グループ化、分割、検証する | core-planning |
| 形式 | 文法全体、ヘッダー/本文/フッターのルール、文字数制限 | core-format |
| タイプ | 一般的なタイプ、プロジェクトレベルの SemVer への影響、それぞれの使い分け | core-types |
機能
| トピック | 説明 | 参照 |
|---|---|---|
| 破壊的変更 | ! 構文と BREAKING CHANGE フッター — 使用する場面と方法 | features-breaking |
| フッター | トークン形式のルール、課題への参照、一般的なトークン | features-footers |
| AI 生成の変更 | エージェントがコミットに貢献する場合、Co-Authored-By による帰属表示が必須です | features-ai-attribution |
コメント
Markdown 対応