commit について
Git の差分から Conventional Commits 形式のメッセージを作成するスキルです。変更の分類からメッセージ作成、安全なコミットまでを開発者向けに案内します。
主な機能
- 01ステージ済み・未ステージの変更を確認
- 02種類、スコープ、説明を分類
- 03本文と課題参照フッターを追加
- 04破壊的変更を明示
- 05コミット前に秘密情報を確認
活用シーン
- 01変更内容に合うコミットメッセージを作成
- 02無関係な変更を別々のコミットに分割
- 03課題参照や破壊的変更を記録
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ angusfretwell/ skills --skill commitインストール後、Claude Code で/commitを入力して読み込まれたか確認します。
詳細
すべてのコミットは Conventional Commits 形式で記述します。<type>(scope): <description> に続けて、任意で本文とフッターを追加します。
手順
- 差分を確認します。
git statusとgit diff --stagedを実行します(ステージされた変更がない場合はgit diffを実行します)。 - 分類します。
type(feat、fix、docs、style、refactor、perf、test、build、ci、chore、revert)、scope(変更の対象領域。変更範囲が広い場合は省略)、description(命令形の72文字未満の1行)を選びます。3つの各要素は、差分内の具体的な変更に対応している必要があります。差分に互いに無関係な変更が複数含まれている場合は、コミットを分けます。 - 構成します。 件名を組み立てます。変更が自明でない場合は、差分だけでは読み手に伝わらない理由や内容を本文に追加し、該当する課題がある場合はフッター(
Closes: <id>、Refs: <id>)を追加します。互換性を破る変更は!(feat(api)!: require verified email)で示すか、説明が必要な場合はBREAKING CHANGE:フッターを追加します。 - コミットします。 対象のファイルをステージします。秘密情報や認証情報が含まれている場合は、作業を中止して報告します。
git commitを実行し、フックを実行させます。フックが失敗した場合は、原因を修正するか報告します。
共有履歴の書き換えやチェックの回避(--force、reset --hard、--no-verify、git config の編集)は、ユーザーが明示的に依頼した場合に限り行います。
コメント
Markdown 対応