GitHub Issueのコメントは書く時に戦々恐々とするものです。分量や記載する内容等、コメントというかwikiじゃないかと思えるほどに積もりゆく文章。とりあえず書いた内容がノイズにならないように心がけ始めたことを書いてみました。 GitHub Issueに作業進捗をコメントとしてこまめに書いていた時期がありました。気がつくと短期間で20コメントくらい付いており、内容を読み取るにも各コメントのコンテキスト理解が必要になり、結果大量のノイズと化していました。 フロー型のSNSのノリで書いていたことも原因だったと思います。最近は意識して体裁建てた結果、1コメントに1ページのWikiのようなノリになりつつあります。そんな書くにも悩ましいGitHub Issueのコメントについて、最近構えた個人的な方針を書いてみることにしました。 とりあえずHeaderでタイトルを書く Issueのタイトルをコ