読者です 読者をやめる 読者になる 読者になる

Git のコミットコメントを英語で書く

同じようなエントリを書いている人は多いが、過去形を勧めている人がいたり現在形を勧めている人がいたりとちょっと混乱する。とりあえずここらを参考にしてみる。ネイティブが書いている記事のほうが安心できる。

まとめると、

  • 1行目は簡潔に書く(メールのSubjectのように)
    • 50文字以内におさめる
    • 文末にピリオドをつけない
    • 先頭は大文字
    • 時制は現在形を使う(Git が自動生成するメッセージも現在形 Merge, Rabaseなど)
  • 2行目以降がある場合は1行目のあと空行が必要
    • 2行目以降は72文字で改行すべき
  • 末尾に Change-Id などを載せる

サンプルは以下のとおり。

Switch libvirt get_cpu_info method over to use config APIs
  
The get_cpu_info method in the libvirt driver currently uses
XPath queries to extract information from the capabilities
XML document. Switch this over to use the new config class
LibvirtConfigCaps. Also provide a test case to validate
the data being returned.

Closes-Bug: #1003373
Implements: blueprint libvirt-xml-cpu-model
Change-Id: I4946a16d27f712ae2adf8441ce78e6c0bb0bb657

ということを守ればよいと思うのだが、海外のコミットコメントを見てると、小文字で始まっていたり、過去形を使っていたり、現在形でも三単現のsがついていたり実際はバラバラっぽい。

結局は自分の中で一貫していることが大事なのかな。

実際にどういうふうな英語が使われているかは、

で記事をまとめている人がいる。

追々、実際のOSSのコミットコメントをみて、マネできるものを挙げていこうかな。