commit について
commit は、Sentryプロジェクト向けのコミットメッセージ規約を定めるスキルです。ヘッダー構成、タイプ、件名と本文のルール、課題参照、変更例をまとめています。
主な機能
- 01必須ヘッダー形式と任意のスコープ
- 02コミットタイプの定義
- 03件名と本文の記述ルール
- 04課題参照のフッター形式
- 05リバートと破壊的変更の例
活用シーン
- 01Sentryのバグ修正コミットの作成
- 02スコープ付き機能変更の説明
- 03コミットフッターでの課題参照
- 04リバートや破壊的変更の形式整理
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ davila7/ claude-code-templates --skill commitインストール後、Claude Code で/commitを入力して読み込まれたか確認します。
詳細
Sentry のコミットメッセージ
Sentry プロジェクトでコミットを作成する際は、以下の規約に従ってください。
フォーマット
<type>(<scope>): <subject>
<body>
<footer>
ヘッダーは必須です。スコープは任意です。すべての行は 100 文字未満に収めてください。
コミットタイプ
| タイプ | 目的 |
|---|---|
feat | 新機能 |
fix | バグ修正 |
ref | リファクタリング(動作の変更なし) |
perf | パフォーマンスの改善 |
docs | ドキュメントのみ |
test | テストの追加または修正 |
build | ビルドシステムまたは依存関係 |
ci | CI 設定 |
chore | 保守作業 |
style | コードの整形(ロジックの変更なし) |
meta | リポジトリのメタデータ |
license | ライセンスの変更 |
件名の規則
- 命令形・現在形を使用してください: "Add feature" とし、"Added feature" とはしないでください
- 先頭の文字は大文字にしてください
- 末尾にピリオドを付けないでください
- 最大 70 文字です
本文のガイドライン
- 何をとなぜを説明し、どのようには説明しないでください
- 命令形・現在形を使用してください
- 変更の動機を含めてください
- 必要に応じて、以前の動作との違いを示してください
フッター: Issue の参照
フッターでは、以下のパターンを使って Issue を参照してください:
Fixes GH-1234
Fixes #1234
Fixes SENTRY-1234
Refs LINEAR-ABC-123
Fixesはマージ時に Issue をクローズしますRefsはクローズせずにリンクします
例
シンプルな修正
fix(api): Handle null response in user endpoint
The user API could return null for deleted accounts, causing a crash
in the dashboard. Add null check before accessing user properties.
Fixes SENTRY-5678
スコープ付きの機能
feat(alerts): Add Slack thread replies for alert updates
When an alert is updated or resolved, post a reply to the original
Slack thread instead of creating a new message. This keeps related
notifications grouped together.
Refs GH-1234
リファクタリング
ref: Extract common validation logic to shared module
Move duplicate validation code from three endpoints into a shared
validator class. No behavior change.
破壊的変更
feat(api)!: Remove deprecated v1 endpoints
Remove all v1 API endpoints that were deprecated in version 23.1.
Clients should migrate to v2 endpoints.
BREAKING CHANGE: v1 endpoints no longer available
Fixes SENTRY-9999
Revert のフォーマット
revert: feat(api): Add new endpoint
This reverts commit abc123def456.
Reason: Caused performance regression in production.
原則
- 各コミットは、単一かつ安定した変更であるべきです
- コミットは、それぞれ独立してレビュー可能であるべきです
- 各コミットの後も、リポジトリは動作する状態であるべきです
参考資料
コメント
Markdown 対応