PR の Description に This PR 動詞
と書くのを多用しているが、PR タイトルとしてはその 動詞
の原形 (命令法) を先頭にしたタイトルを考えるようにしている。なので PR としてどういった影響を与えるパッチになるのかを主眼に考えるようにしている気がする。
例を挙げる。
- 本文が
This PR fixes ...
であればタイトルはFix ...
ではじまる - 本文が
This PR adds ...
であればタイトルはAdd ...
ではじまる - 本文が
This PR uses ...
であればタイトルはUse ...
ではじまる
先頭を大文字にピリオドを付けずになど、概ね以下のルールに従うことにしている。
この記事の原文は RuboCop の PR テンプレートでも以下の頃より引用されている。