commit について
Sentry プロジェクト向けのコミットガイドスキルです。コミットメッセージの作成や変更のコミットに使い、形式、課題参照、ブランチ確認、無関係な変更の保護方法を定めています。
主な機能
- 01Sentry のコミット形式
- 02Conventional Commit のタイプ
- 03課題参照の規則
- 04ブランチとリポジトリ方針の確認
- 05無関係な変更の保持
活用シーン
- 01Sentry 形式のコミットメッセージ作成
- 02コミット前のブランチ安全性確認
- 03コミットでの課題参照
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ sickn33/ agentic-awesome-skills --skill commitインストール後、Claude Code で/commitを入力して読み込まれたか確認します。
詳細
Sentry のコミットメッセージ
Sentry プロジェクトでコミットを作成する際は、以下の規約に従ってください。
使用する場面
- ユーザーからコードのコミット、コミットメッセージの準備、または git での変更の保存を求められた場合。
- conventional commit の構成とイシュー参照を含む、Sentry スタイルのコミット形式が必要な場合。
- コミット前にブランチの安全性を確保する必要がある場合。特に、
mainまたはmasterに直接コミットしないようにする場合。
前提条件
コミットの前に、必ず現在のブランチを確認してください。
git branch --show-current
コミットを作成する前に、リポジトリのポリシーを確認してください。デフォルトブランチが PR 専用の場合は、管理者がサーバー側のチェックを回避できる場合でも、許可されたトピックブランチを作成し、リポジトリ標準のメンテナーフローを使用してください。AAS では、antigravity-maintainer-batch-release と保護されたソース PR が必須です。
git status --short、git diff --cached、および変更対象のパスを確認し、無関係なステージ済みまたは未コミットの変更は保持してください。インストール済みの create-branch ヘルパーは、利用可能かつ適切な場合にのみ使用してください。それ以外の場合は、リポジトリのワークフローを通じてトピックブランチを作成してください。続行する前に、実際のブランチを確認してください。メッセージのみを求める依頼は、ステージング、コミット、またはプッシュの許可を意味しません。
形式
<type>(<scope>): <subject>
<body>
<footer>
ヘッダーは必須です。スコープは任意です。すべての行を 100 文字以内にしてください。
コミットの種類
| 種類 | 用途 |
|---|---|
feat | 新機能 |
fix | バグ修正 |
ref | リファクタリング(動作の変更なし) |
perf | パフォーマンスの改善 |
docs | ドキュメントのみ |
test | テストの追加または修正 |
build | ビルドシステムまたは依存関係 |
ci | CI 設定 |
chore | メンテナンスタスク |
style | コードのフォーマット(ロジックの変更なし) |
meta | リポジトリのメタデータ |
license | ライセンスの変更 |
件名のルール
- 命令形の現在形を使います。「Added feature」ではなく「Add feature」とします。
- 先頭の文字を大文字にします。
- 末尾にピリオドを付けません。
- 最大 70 文字です。
本文のガイドライン
- 方法ではなく、何を、なぜ行うのかを説明します。
- 命令形の現在形を使います。
- 変更の動機を含めます。
- 該当する場合は、以前の動作との違いを示します。
フッター:イシュー参照
以下の形式を使って、フッターでイシューを参照します。
Fixes GH-1234
Fixes #1234
Fixes SENTRY-1234
Refs LINEAR-ABC-123
Fixesは、マージ時にイシューをクローズします。Refsは、イシューをクローズせずにリンクします。
AI が生成した変更
リポジトリの帰属表示ポリシーに従い、実際の貢献者を明記してください。以下は Claude の場合の例です。別のエージェントが作成した成果物に付けたり、個人の貢献を捏造したりしないでください。
Co-Authored-By: Claude <[email protected]>
リポジトリの帰属表示および開示に関する規則を優先してください。コミットメッセージの件名、本文、その他の箇所に、「Generated by AI」、「Written with Claude」などの表現や類似の目印を追加しないでください。
例
シンプルな修正
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
Co-Authored-By: Claude <[email protected]>
スコープ付きの機能
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: feat(api): Add new endpoint
This reverts commit abc123def456.
Reason: Caused performance regression in production.
原則
- 各コミットは、単独で完結する安定した変更にしてください。
- コミットは、それぞれ独立してレビューできるようにしてください。
- 各コミット後、リポジトリが正常に動作する状態を保ってください。
参考資料
制限事項
- タスクが上記の範囲に明確に該当する場合にのみ、このスキルを使用してください。
- main への直接コミットを指示されても、サーバー側のブランチ保護と必須チェックが優先されます。
- 出力を、環境固有の検証、テスト、または専門家によるレビューの代わりとして扱わないでください。
- 必要な入力、権限、安全上の境界、または成功基準が不足している場合は、作業を中断して確認してください。