[GitHub] Multi-line code suggestionsでコード提案機能が便利になりました

2020.04.16

以前からベータ版で提供されていた「Multi-line code suggestions(複数行のコード提案機能)」がGAされました。全てのGitHubユーザーがこの機能を利用できます。

GitHubのSuggestion機能

GitHubのSuggestion機能はプルリクエストのレビューでコードの変更を提案する機能です。Multi-line code suggestionsが実装されたことで、複数行のコードに対して提案ができるようになりました。

コードの変更を提案

プルリクエストのレビューでコードの変更を提案するには、Files changed(変更されたファイル)を表示してコメントを登録します。

Github Files Changed

変更対象の行を+ボタンを押して選択します。複数行を選択する場合は、ドラッグ&ドロップかShiftボタンを押して範囲を指定します。また、コメント欄が表示されたら、Insert a suggestionのボタンをクリックするとsuggestionが挿入されます。

Github Insert a suggestion

suggestionに変更を提案するコードを入力します。

Github suggestion

コメントを登録すると差分が表示されます。

Github Suggestion 差分

提案されたコードをコミット

Commit suggestionを開くとメッセージを入力してコミットできます。

Github Suggestion Commit

新しいコミットとして追加されました。

Github commit log

まとめ

GitHubのSuggestion機能を活用することで、レビューイとレビュアーの負担を減らすことができます。複数行対応により活用できる範囲も広がりましたので、積極的に使用してみようと思います。

参考資料