イシュー参照付きのフッター
Conventional Commitsにフッター参照を追加する方法。イシュー、レビュアー、メタデータをリンクするためのkey: valueとkey #valueフッター形式を学びます。
Best Practices
詳細な説明
Conventional Commitsのフッター形式
フッターはコミット本文の後(本文がない場合は件名の後)に、空行で区切って表示されます。2つの形式のいずれかに従います:
形式1:key: value
Reviewed-by: Alice Smith
Refs: https://jira.example.com/PROJ-123
Signed-off-by: Bob <bob@example.com>
形式2:key #value
Closes #456
Fixes #789
Refs #123
完全な例
feat(notifications): add email digest for weekly summary
Users can now opt in to receive a weekly email digest
summarizing their activity. The digest includes new
followers, likes, and comment replies.
Closes #234
Refs #180, #201
Reviewed-by: Carol
Co-authored-by: Dave <dave@example.com>
一般的なフッタートークン
| トークン | 目的 | 例 |
|---|---|---|
Closes |
マージ時にイシューをクローズ | Closes #123 |
Fixes |
マージ時にイシューを修正 | Fixes #456 |
Refs |
関連イシューの参照 | Refs #789 |
Reviewed-by |
レビュアーのクレジット | Reviewed-by: Alice |
Co-authored-by |
共著者のクレジット | Co-authored-by: Bob <b@x.com> |
Signed-off-by |
DCOサインオフ | Signed-off-by: Carol <c@x.com> |
BREAKING CHANGE |
破壊的変更の説明 | 専用の例を参照 |
GitHubの自動クローズキーワード
GitHubはこれらのトークンを認識し、コミットがデフォルトブランチにマージされると参照されたイシューを自動的にクローズします:close、closes、closed、fix、fixes、fixed、resolve、resolves、resolved。
検証
リンターはフッター行がkey: valueまたはkey #value形式に一致するかチェックします。どちらのパターンにも一致しない行は、複数行のフッター値の続きの行である可能性があるため、警告としてフラグが立てられます。
ユースケース
コミットをイシュートラッカーにリンクし、レビュアーや共著者にクレジットを付与し、サインオフなどのメタデータを追加するためにフッター参照を使用します。これにより、コミットとそれが対処するイシューの間にトレーサブルな接続が作成され、プロジェクト管理や監査証跡に非常に有用です。