commit について
開発者向けのコミットメッセージ作成スキルです。ブランチ確認、形式、プライバシー規則に加え、変更の分け方や課題・破壊的変更のフッターを説明します。
主な機能
- 01コミット前のブランチ確認
- 02メッセージ種別と形式の指定
- 03まとまりのある変更の分割指針
- 04コミット内容のプライバシー規則
- 05課題と破壊的変更のフッター
活用シーン
- 01フィーチャーブランチでのコミット準備
- 02リファクタリングの種別選択
- 03コミットへの課題参照の記録
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ getsentry/ skills --skill commitインストール後、Claude Code で/commitを入力して読み込まれたか確認します。
詳細
Sentry のコミットメッセージ
コミットする前に
git branch --show-current
ブランチが main または master の場合、ユーザーが直接コミットを明示的に依頼していない限り、フィーチャーブランチを作成します。ブランチを再確認し、まだ main または master の場合は中止します。
一度にコミットする変更は、まとまりがあり、独立してレビューできるものにします。
メッセージのルール
次の形式を使用します。
<type>(<scope>): <subject>
<optional body>
<optional footer>
- スコープは省略可能です。破壊的変更の場合は、
:の前に!を付けます。 - 件名は命令形かつ現在形で記述し、先頭を大文字にし、末尾のピリオドを省略して、70 文字以内にします。
- すべての行を 100 文字未満にします。
- 本文は必要な場合にのみ記述します。変更内容と理由を説明し、役立つ場合は以前の動作や変更の動機も含めます。
- 顧客名や組織名、ユーザーのメールアドレス、サポートチケットの内容、秘密情報、PII は決して含めないでください。代わりに、技術的な症状を説明します。
使用できるタイプ:feat、fix、ref、perf、docs、test、build、ci、chore、style、meta、license、revert。
動作を変更せずにリファクタリングする場合は ref、ロジックを変更せずにフォーマットを変更する場合は style、リポジトリのメタデータには meta を使用します。
フッター
Fixes <issue>は、マージ時にイシューをクローズします。Refs <issue>は、イシューにリンクしますが、クローズはしません。- 破壊的変更の場合は、
BREAKING CHANGE: <impact>を追加します。
コミットの作成
段落とフッターには、個別の -m 引数を使用します。コミットメッセージにリテラルの \n を含めたり、対話型エディターを開いたりしないでください。
git commit -m "fix(api): Handle null response in user endpoint" \
-m "Return 404 when the user API finds a deleted account." \
-m "Fixes SENTRY-5678"
コメント
Markdown 対応