PRレビューを一括取得して学習資料化するnpmを公開
概要
タイトルの通りですが、駆け出しエンジニアの皆さん、先輩方からのありがたいコードレビューをどうやって確認及び管理されてますかね？？
今のgithubの仕様上、それぞれのPRに行ってレビュー毎のコメントを一つずつ確認しないといけない感じじゃないでしょうか。実務だとPRが大量になるし忘れちゃうことも多々あると思います。
個人的に先輩方からのコードレビューはマジで成長できる最大の材料だと思っていて、そのレビューをどうにかもっと簡単にまとめて管理したいと思ったのがきっかけで作りました。
結論から言うと、リポジトリで自分が投げたPRに対してのレビューをPRごとの一覧と詳細をmdファイルで出力してくれます。markdownなのでそのままコピペしてnotionにぶち込むもよし、そのまま確認するもよしです。
もちろんレビューを受けた該当コード箇所も吐き出してくれますのでご安心を。(後に解説)
公開したパッケージ
Githubページ
一応、Githubには依頼出して何人かの海外エンジニアからは賛同のコメントもらってるんですが、実際に機能が実装されるかどうかはGithub次第で確実ではないので、一旦簡易的なものを作ったという流れになります。よかったら↑ボタンや賛同コメントしていただけると、盛り上がってGithubが実装してくれるかも🤔
ちなみに1日でDL数が2000超えたので、やっぱこの機能GitHub本体に追加されて欲しいなと思ってるところです
使い方
READMEに書いてある通りですが、以下の流れで使用できます
1. アクセストークン取得
取得方法はこちらをみていただけると
2. パッケージインストール
自分がレビューを取得したいPRがあるリポジトリに移動した状態で行ってください
npm install -g get-gh-reviews
3. .envファイルに1で取得したトークン入れる
.env
GITHUB_TOKEN=ghp_pkorehatekitounatokendesunodegoannshinnwo
4.あとはコマンド叩くだけ
READMEにある目的のコマンドを叩きましょう。
おそらく下記コマンドが一番使いやすいかと思います
※グローバルインストールしてない方はコマンドの頭にnpxつけてください
get-gh-reviews reviews -u your-username --markdown my-reviews.md
これを叩くと以下のようにありがたきレビューとその一覧および詳細がreport.mdファイルに出力されます
詳細部分ももちろん出力されて、クリックすれば実際のページへ飛べます
最後に
冒頭にも書きましたが、AIでバイブコーディングできるようになったからこそ、自分よりレベルの高い方からの実レビューこそ成長できる宝物だと思います。
そして、人間は一度指摘されても忘れる生き物なので、是非、こんな感じで自分だけの学習資料を作っていきましょ〜
Discussion