git-commit について
Conventional Commits に沿った Git のコミットメッセージを書くためのスキルです。投稿者向けに、本文や破壊的変更、署名、ブランチ名の規則も示します。
主な機能
- 01Conventional Commits 形式
- 02コミット種別とスコープの指針
- 03件名と本文の規則
- 04破壊的変更の表記
- 05ブランチ命名規則
- 06ID と署名の保護
活用シーン
- 01機能追加や修正のコミット作成
- 02破壊的変更の説明
- 03作業用ブランチの命名
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ fredrikaverpil/ dotfiles --skill git-commitインストール後、Claude Code で/git-commitを入力して読み込まれたか確認します。
詳細
Git コミットメッセージ
Conventional Commits 仕様に従ってコミットメッセージを記述します。
形式
<type>(<scope>): <description>
[optional body]
[optional footer(s)]
種類
| 種類 | 用途 |
|---|---|
feat | 新機能 |
fix | バグ修正 |
docs | ドキュメントのみ |
style | コードスタイル(フォーマット、ロジックの変更なし) |
refactor | バグ修正や機能追加を伴わないコード変更 |
perf | パフォーマンスの改善 |
test | テストの追加または修正 |
build | ビルドシステムまたは外部依存関係 |
ci | CI 設定 |
chore | メンテナンスタスク |
revert | 以前のコミットを取り消す |
ルール
- 説明には命令形を使います(「機能を追加する」。 「追加した」ではありません)
- 説明の末尾にピリオドを付けません
- 説明は 72 文字未満にします
- 件名と本文の間には空行を入れます
- 本文では差分の言い換えではなく、変更の意図、注意点、想定外の挙動、背景を説明します
破壊的変更
型またはスコープの後に ! を付けるか、フッターに BREAKING CHANGE: を含めます。
feat(api)!: remove deprecated endpoints
BREAKING CHANGE: The /v1/users endpoint has been removed.
スコープ
省略可能です。変更対象の領域(例:api、ui、auth、db)を指定します。
ブランチの命名
新しいブランチを作成するときは、コミットメッセージと同じ種類を使って <type>/<kebab-description> という名前を付けます(例:feat/add-user-auth、fix/broken-symlinks)。
例外:環境によってブランチ名がすでに割り当てられている場合(Claude クラウドサンドボックスのセッションにおける claude/... ブランチなど)は、そのまま使用してください。この規約に合わせるために名前を変更したり、別の名前のブランチを作成したりしないでください。
アイデンティティ、署名、帰属
Git のアイデンティティとコミット署名は環境によって設定されます(開発者マシンでは gitconfig、クラウドサンドボックスでは SessionStart フック)。どちらも環境に任せてください。
- メッセージには変更内容のみを記述します。
Co-Authored-By、「Generated with」の行、セッションへのリンク、モデル名は含めません。 - 作成者は Git に設定から解決させます。
--authorや-c user.name=.../-c user.email=...を指定せずにコミットします。 - 署名は Git に設定から解決させます。
-S、--gpg-sign、--no-gpg-signを指定せずにコミットし、署名関連の設定はそのままにします。
コメント
Markdown 対応