Github Comment TrackerでプルリクエストのコメントをToDoリスト化し、対応状況を管理する

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

「自分の出したプルリクエスト(以下PR)につくコメントって概ねToDoリストだな」と感じています。 そして、ToDoリストなのであれば対応状況を管理したい、という思いがありました。

具体的には「議論の起点」「修正の提案」「指摘」などありますが、いずれにせよ何かしらアクションをしなくてはならず、対応済みなのかどうかを明示的にしておきたい、ということです。

本記事で紹介するGithub Comment Trackerは、PRについたコメントをToDoリスト化し、完了ステータスの管理と未対応のコメントを表示するためのChrome拡張となります。

Github Comment Tracker

導入するとどうなるのか

導入自体は通常のChrome拡張なので割愛します。Chromeウェブストア | Github Comment TrackerからChromeに追加可能です。

大雑把な動作イメージ

以下のアニメで何に使えるものなのかだいたいわかるかと思います。

コメントに対してUnsolved/Resolvedボタンが追加され、Unsolvedなコメントの一覧が表示される

導入すると各コメントに対してボタンが表示され、ステータスを管理することができるようになります。

また、Unsolvedなコメントの一覧がマージボタンの下に表示されるため、対応漏れに気づくことができます。

コメントをResolvedにするとマージボタンの下のUnsolvedなコメントが消える

コメントに対する対応が完了したら、ボタンをクリックするとステータスが切り替わります。

Resolvedになったコメントはマージボタンの下のコメント一覧から削除されます。

全てResolvedにすると警告が消えます。 対応漏れがないことを確認してからマージ、という流れで作業することができます。

まとめ

Github Comment Trackerでは、GitHubのPR上に書き込まれたコメントをタスク化し、「完了ステータスの管理」と「未対応のコメント一覧の参照」を行えます。

本ツールの導入によって、PRにもらったコメントへの対応を忘れたままマージしてしまうリスクなど軽減できるのではないでしょうか。

以前は完了したことをコメントに返信したりしていたのですが、これはこれで「相手にとって特に有益でないメンションが飛ぶ/対応漏れの確認が面倒」などの懸念がありました。

特に巨大なPRや、ジョインしたばかりで規約など把握しきれていないプロジェクトへのPRを出す場合に有効なツールだと思います。

私からは以上です。