プルリクへのセルフコメントという小技 - Melting Pot of Thoughts

プログラミングにおいて、お気に入りのよく使っている小技として「プルリクにセルフコメントしまくる」という小技があります。 良いプルリクの作り方については検索すれば色々ネット上に情報が転がっているのですが（説明文の書き方、PR分割の方針…etc）、セルフコメントについてはあまり見たことがないのでTipsとして取り上げてみました。 ※ 前提：各用語は以下の意味で使っています。 「プルリク」はGithubのプルリクスト（＝マージリクエスト）のことを指します 「セルフコメント」は自分で作ったプルリクエストのコード差分行やあるいはプルリク全体に対しコメントをつけることを指します。 セルフコメントにおいては、「レビュアーへの質問」「レビュアーへの説明（修正背景の意図など）」「やり残したTODOの備忘メモ（例：マージ後XXXしないといけない）」などを書きます。 これをすると以下のメリットが得られます。 メ

[berlysia]

よくやる。これをやってると実はコード側に書いた方が良かったなということも後から見えてきて良いと思うし、レビューする側としてもレビューが必要そうな場所が察せて良い

[negative_goggle]

ていねいでえらい。

[mizdra]

よくやる。レビュワー側の視点に立って補足説明を書き残せるので便利に使ってます。