レビューがしやすいように不具合修正PRの概要に書くこと

いいPRの概要の書き方をしている方を見かけたのでメモする。

不具合修正PRの概要に書くことは以下の3つ。

1. 不具合の内容
2. 不具合の原因
3. 不具合の解消方法

１は、大体いつも書くPRの「概要」と同じ要領で書く。

２は、３をしなければならない根拠として書く。

３は、コードにそれが書いてあるので、それを言葉で書く。

　この３つのことが書いてあるPRは、レビュワーが不具合について理解することを助けてくれるので負担を和らげてくれる。さらに、これにより不具合対応にかかる時間を早くできる可能性もある。