イシュー参照付きフッター

イシュー参照、共著者、その他のメタデータのためにコミットメッセージにフッターを追加する方法を学びます。Closes、Fixes、Refsキーワードと複数フッターの使い方を解説します。

Multi-line

詳細な説明

コミットメッセージのフッター

フッターはボディの後(空行で区切られて)に表示され、コミットに関するメタデータを含みます。最も一般的な使用はイシューの参照ですが、フッターには共著者、サインオフ、その他の構造化データも含めることができます。

イシュー参照キーワード

Gitホスティングプラットフォームはフッターで以下のキーワードを認識します:

キーワード 効果
Closes #123 マージ時にイシューを閉じる
Fixes #123 Closesと同じ
Resolves #123 Closesと同じ
Refs #123 閉じずにイシューにリンク
Related #123 非公式な参照

フッター付きの例

fix(auth): prevent session fixation attack

Regenerate session ID after successful login to
prevent session fixation. Previously, the session
ID remained the same before and after authentication,
allowing an attacker to set a known session ID.

Closes #445
Refs #312

複数のフッター

複数のフッターを含めることができ、各フッターは独自の行に記載:

feat(api): add batch processing endpoint

Implement /api/batch for processing up to 100
requests in a single HTTP call. Responses are
returned in the same order as requests.

Closes #890
Closes #891
Refs #850
Co-authored-by: Jane Smith <jane@example.com>

クロスリポジトリ参照

他のリポジトリのイシューを参照する場合:

Closes org/other-repo#234

フッターとしてのBREAKING CHANGE

BREAKING CHANGE:フッターは特別なケースです:

feat!: drop IE11 support

Remove all IE11-specific polyfills and CSS hacks.
This reduces the bundle size by 15KB.

BREAKING CHANGE: Internet Explorer 11 is no longer
supported. Users must upgrade to a modern browser.
Closes #1024

Signed-off-byとトレーラー

一部のプロジェクトは法的コンプライアンスのためにサインオフを要求します:

docs: update privacy policy for GDPR compliance

Signed-off-by: Developer Name <dev@example.com>
Reviewed-by: Legal Team <legal@example.com>

ユースケース

イシュートラッカーに報告されたセキュリティ脆弱性を修正しました。より広範なセキュリティ監査イシューにも関連しています。特定のバグレポートを閉じ、監査イシューを参照し、報告したセキュリティ研究者をクレジットするコミットメッセージが必要です。

試してみる — Git Commit Message Generator

フルツールを開く