覚書

IssueやPull Requestを作る時、良いタイトルをつける

  • 1ヶ月や半年ごとに振り返るとき、GHEのIssueやPRベースで振り返ることが多い。そうなると、それらのタイトルやカテゴリが重要になってくる。タイトルだけで何をしたのかが分かるのであれば、そのIssueの説明は少なくていい。カテゴリが明確になっていればカテゴリごとに分けて並べることで、その1ヶ月や半年どういう仕事をしたのかが可視化されるだろう
  • Issue、PRを作る時のタイトルやラベルについて、後からみてわかりやすくなっているかどうかをプログラマブルに判断したい

https://twitter.com/Megumi\_Isogawa/status/1200293549096357888

#Backlog の課題の件名、体言止め禁止ルール。私が登録する課題の件名は全部「〜〜する」形式です😍課題の件名だけで概要が分かることが大事。これは、#JBUG で学んだすごく有意義で実用的なTipsのひとつ。

https://qiita.com/janus\_wel/items/ba47259f107b161c5727

すべての事柄を説明・主張を表現でき、かつ誰が見ても誤解がないような Title がベスト

バグ報告なのか、提案なのか、タスクなのかで若干変わってくる。

https://qiita.com/awakia/items/c571e93e96a1ec28044f#良い-issue-の書き方

専門知識がなくても、わかりやすいタイトルを付ける WHYを書く 今ここにいない人のことも考える 新入社員、他のチームで近い部分を変更する人、1年後のすでに他人となった自分 git blameや検索で、後で見られることも実際何度もあった

うむうむ。