GitHub Issueに作業進捗をコメントとしてこまめに書いていた時期がありました。気がつくと短期間で20コメントくらい付いており、内容を読み取るにも各コメントのコンテキスト理解が必要になり、結果大量のノイズと化していました。 フロー型のSNSのノリで書いていたことも原因だったと思います。最近は意識して体裁建てた結果、1コメントに1ページのWikiのようなノリになりつつあります。そんな書くにも悩ましいGitHub Issueのコメントについて、最近構えた個人的な方針を書いてみることにしました。 とりあえずHeaderでタイトルを書く Issueのタイトルをコメントのタイトルとみるべきである、そう思っていた時期はありました。とんでもない。 コメント自体にもタイトルをつけると読み取りにくくなるのではと思われそうですが、スクリーンショットやコードスニペットを交えているとそれらの意図概要としてタ
![GitHub Issueコメントに費やすカロリーを増やした結果振り返りやすくなったというお話 | DevelopersIO](https://cdn-ak-scissors.b.st-hatena.com/image/square/d1762eaf81b2855f2648b259156f5cb9c7592542/height=288;version=1;width=512/https%3A%2F%2Fdevio2023-media.developers.io%2Fwp-content%2Fuploads%2F2019%2F07%2Fgithub-eyecatch.png)