【ツール活用|豆知識】GitHubの「インラインサジェスト」でコードレビューを爆速化する方法

導入:レビューの「修正依頼」に時間をかけていませんか?

コードレビューで「この変数名、もう少し分かりやすくしてほしい」「ここのタイポを直して」とコメントした際、相手がそれを修正して再度プルリクエストを更新する……この往復は地味に時間がかかります。GitHubの「インラインサジェスト」機能を使えば、レビュアーが直接修正コードを提示し、作者はボタン一つでそれを適用できます。コミュニケーションコストを劇的に下げ、本来のロジックレビューに集中するための必須テクニックです。

基礎知識:インラインサジェストとは

インラインサジェスト(Suggestion)とは、プルリクエストのレビュー時に、レビュアーが修正案をコードブロック形式でコメントに挿入できる機能です。
仕組み:レビュアーが提案したコードはGitHub上で「Apply suggestion」というボタンとして表示されます。作者がこれをクリックすると、自動的にその修正内容がコミットとして取り込まれます。手作業でのコピー&ペーストや、修正後の再確認の手間が省けるため、開発スピードが向上します。

実装・解決策:サジェストの作り方

手順は非常にシンプルです。
1. プルリクエストの「Files changed」タブを開く。
2. 修正を提案したい行の左側にある「+」アイコンをクリック。
3. コメント入力欄で、ツールバーにある「+」アイコン(Add suggestion)を選択する。
4. 生成されたコードブロック内に、修正後のコードを記述する。
5. コメントを投稿する。

これだけで、相手に「修正案」を明示的に伝えることができます。

サンプルプログラム:レビューコメントへの適用例

以下は、タイポを修正する際のサジェスト記法の例です。Markdownのコードブロック記法()を使うのがポイントです。

この変数名ですが、スペルミスの可能性があるため修正を提案します。

// タイポを修正し、意図を明確にした変数名に変更
const userAuthentication = true;

※上記のコードをそのままコピーしてGitHubのコメント欄に貼り付けると、自動的に「Apply suggestion」ボタンが生成されます。

応用・注意点:現場で陥りやすい罠

インラインサジェストは非常に強力ですが、以下の点に注意してください。

1. 修正範囲の大きさに注意:
数行程度の修正には最適ですが、数十行にわたる大規模なリファクタリングをサジェストで行うと、差分が見づらくなり、作者が意図を汲み取りにくくなります。大きな変更は口頭やミーティングで相談しましょう。

2. コンテキストを添える:
サジェスト機能は便利ですが、コードだけを貼り付けると「なぜ修正が必要か」が伝わりません。「パフォーマンス向上のため」「命名規則に合わせるため」など、必ず修正理由を併記することが、チームの学習効率を高めるコツです。

3. 権限の確認:
サジェストを適用するには、対象のプルリクエストに対するプッシュ権限が必要です。外部コントリビューターからの提案をマージする場合は、手動で反映する必要があるため注意してください。

この機能を使いこなして、レビューの待ち時間を減らし、チームの生産性を高めていきましょう!

コメント

タイトルとURLをコピーしました