PullRequestの説明をなんども書き直す
PullRequestの説明は、コメントを受けて何度も書き直すとよい
コメントでの議論を受けて、説明を書き直した方がよいと思ったら書き直すとよい
説明を書き直すことでPullReqeustの目的が明確になる
後から見直したときにコメントの議論を読まなくても説明を読めばわかる
コメントの議論を受けてコードを直すことはよくあるけど、説明を書きなおすだけでよいこともある。それくらい説明大事
実はgithubのプルリク概要欄はどんどん書き直すことが想定されていますshokai.icon
バージョン管理されているから
https://gyazo.com/ee44f0ebfb77085ede869dc59f23fc12
pull request概要とコメントは
revert・修正は忙しい状況で行われる
bugが発生した時の問題切り分け
新機能追加で機能同士の衝突が起きた時
だから初見の人が読んで理解できるドキュメントとして、概要欄はメンテナンスしなければならない
GitHub には打ち消し線がなくて困っていましたが、なにか GitHub 側の意図がありそうですね。hata.icon ありそうshokai.icon