Gerrit/Commit message guidelines/ja

変更のコミット メッセージは重要な役割を果たします. あなたの変更について、他の人が最初に目にする場所です.

件名
コミット メッセージの最初の行は件名として知られています. 件名は 80 文字未満にする必要があります (50〜70 文字を目指します).


 * 件名の行では変更を要約します. これはリポジトリに永遠に残ることを心に留めておいてください.
 * 件名の行では命令形を使用してください. 命令形は、誰かに指示を与えているように聞こえます. "Change", "Fix", "Add", "Remove", "Document", "Refactor" のような単語で始まることがあります.
 * いい例は "Add Badge::query to query the API", "Avoid API query in SimpleBadge", "Support zeroes in SimpleBadge::add".
 * 悪い例は "Added Badge::query method", "Fixed Badge::query method", "Badge can query the API", "Badge doesn't do API queries", "Zeroes work when adding badges".
 * 件名の行は短くし、あなたのコミットが何を変更するかを明確に記述する必要があります.  異なることを行う2つのコミットに対して、同じ件名は使用できないはずです.  変更フィード、コード レビューのメール、git-blame のログ、リリース ノート、展開 (deployment) の変更履歴などで、あなたの件名が流れてくると、人々は文脈を無視して読んでしまいます.  いい件名は、数多くのコミットの中から、特定の興味や関心に関連するかどうかを素早く判断するのに役立ちます.
 * いい例: "badger: Add accessibility labels to form fields", "rdbms: Avoid infinite loop on null input", "htmlform: Change colours to match April 2020 design".
 * 悪い例: "Implement accessibility fixes", "Don't crash", "Make prettier with a better design".
 * 件名の末尾にピリオド/ドット を付けないでください.
 * 必要に応じて、関連するコンポーネントを件名の前に付けます. コンポーネントは、コミットが変更する全般的な領域です.

本文
本文を書く際は、以下の質問について考えてください:


 * この変更を行う必要がある理由は? 現在のコードの何が問題点になっていますか?
 * この方法で変更する必要がある理由は? 他の方法はありますか?
 * 他のアプローチを検討しましたか? その場合は、それらのアプローチがそれほどよくなかった理由を説明してください.
 * レビュアーはどのようにして、コードが正しく機能していることをテストまたは検証できますか?

すること:


 * 本文と件名を 1 行の空行で区切ります.
 * 行が最大 100 文字になるように、メッセージを折り返します. Many editors/tools can do this automatically; 72 characters is a common width to wrap at. ただし、URL は「フィット」させるために分割するとクリックできなくなるため、長くなってもそのままにしてください.
 * 他のコミットがマージされた場合、(短い) Git コミットハッシュを使用して参照します. まだマージされていない場合は、Gerrit Change-Id を使用して参照してください.

してはいけないこと:


 * 他のコミットを参照する際に Gerrit の URL を使用する.
 * 代わりに、Git のコミット ハッシュを使用します. これにより、オフライン時に Git リポジトリ内で簡単に遷移できます.  さらに、すべてのリポジトリ ビューアー (Gerrit、Gitiles、Phabricator、GitHub、ローカル Git インターフェイス) の利用者が、同じインターフェイス内の他のコミットに自動的に移動できるようになります.  URL は、オンラインでかつ Gerrit を使用している場合にのみ解決できるため、人々はすばやく遷移できなくなります.
 * 変更の説明として URL のみを使用する.
 * 変更が他の場所での議論または外部の説明文書によって正当化される場合は、コミット メッセージの関連するポイントを簡潔に要約します.

フッターとメタ データ
フッターの最も重要な情報は、 (必須) と   です.


 * " " と " " のメタデータを以下の例とまったく同じように整形し、本文の最終行の後に空行を入れた後に一緒に配置します.

各メタ データ フィールドの詳細情報は、下記を参照してください.

いい例
jquery.badge: Add ability to display the number zero

Cupcake ipsum dolor sit. Amet tart cheesecake tiramisu chocolate cake topping. Icing ice cream sweet roll. Biscuit dragée toffee wypas.

Does not yet address T44834 or T176. Follow-up to Id5e7cbb1.

Bug: T42 Change-Id: I88c5f819c42d9fe1468be6b2cf74413d7d6d6907

悪い例
Improved the code by fixing a bug.

Changed the files a.php and b.php

Bug: T42 Change-Id: I88c5f819c42d9fe1468be6b2cf74413d7d6d6907

件名
私たちが使用するほとんどのプログラムは、Git コミットを表示する際に件名をプレーン テキストとしてレンダリングします. つまり、URL が機能せず、テキストの選択/コピーができないことがよくあります. したがって、件名の行内で Phabricator タスク、Git コミット、URL には言及しないでください. 代わりに、本文またはフッターのメタデータで言及してください. こうすることで、普遍的に選択、コピー、クリックできます.


 * Gerrit は件名を、メール通知、IRC 通知、検索結果で使用します.
 * GitHub は件名を以下で使用します: コミット履歴, コミットの件名.
 * Git CLI (コマンドライン インターフェイス) は件名を以下で使用します:,  ,  ,  , etc.
 * その他多数
 * その他多数

コンポーネント
件名の先頭をコンポーネントにすることで、コミットによってプロジェクトのどの領域が変更されるかを示すこともできます.

以下のいずれかである必要があります:


 * や  配下の PHP クラスのディレクトリ ("installer", "jobqueue", "objectcache", "resourceloader", "rdbms" など)
 * PHP クラス名 ("Title", "User", "OutputPage" など). 通常、 に下位ディレクトリがないクラスの場合.
 * ResourceLoader モジュール名 ("mediawiki.Title", "mediawiki.util" など).
 * 変更の種類に関連する複数の領域に影響する汎用的なキーワード. 例:
 * "build" - 開発ワークフローに関連するファイルの変更 (,  の更新など) の場合
 * "tests", "qunit", "phpunit" - 単体テストや統合テストのスイート、またはテスト スイート ランナーのみに影響する変更の場合.

Phabricator
のバグまたはタスクを参照するには、コミット メッセージで Txxx 表記を使用してインラインで言及します (例:「That was caused by T169.」)

コミットが (部分的にでも) 解決するか、特にバグに関連することを表現するには、コミット メッセージの末尾にあるフッターに  を追加します. (コミット メッセージを修正 (amend) する場合は、 行のすぐ上に挿入します.   行との間に空白行は挿入しません. 全体の構造ルールに従って、本文と件名を 1 行の空白行で区切ることを忘れないようにしましょう. )

Bug: T169

ボットは Phabricator タスクに、重要なイベント (マージ、破棄など) に関するコメントを自動的に残します. パッチが 2 つ以上のバグを解決する場合は、各  参照を末尾の独自の行に (1行に1個) 配置します.

Bug: T299087 Bug: T299088

相互参照
別のコミットを参照するときは常に、マージ済みのコミットの SHA-1 git ハッシュを使用します. コミットがまだ保留中のレビューの場合は、git ハッシュの代わりに Gerrit Change-Id ハッシュを使用します. これは、git ハッシュが個々のパッチセット (リベース時に変更されるため、行き止まりが生じる) に関連しているためです.

変更 ID
の  ツールは、新しいコミットに「 」キーワードを自動的に追加します.

依存関係
クロス リポジトリ依存関係がある場合 (=コミットは別のリポジトリの別のコミットに依存している)、最後の段落に  を追加することで宣言します. (「Ixxx」... は他のコミットの  です. ) これは、Zuul に当該コミットと一緒にテストするように指示します.

他の人をクレジット表示する
Change-id の前にこの行を追加して、変更に取り組んでいる他の開発者のクレジットを表示します. 改行で区切って複数人を追加できます.

参考資料

 * Node.js コミット ガイドライン
 * Git コア コミット ガイドライン
 * jQuery コミット ガイドライン
 * Erlang コミット ガイドライン
 * Git コミット メッセージについての注記 - Tim Pope 著
 * Git コミット メッセージの書き方 - Chris Beams 著
 * Gerrit integrations with the Puppet Catalogue Compiler
 * Git コミット メッセージの書き方 - Chris Beams 著
 * Gerrit integrations with the Puppet Catalogue Compiler