アルパカログ

GitHub コードレビューでサジェスション機能を使って差分を提案しよう

2020年11月11日
🔖Git・GitHub

GitHubを使ったチーム開発では、コードレビューの際に「ここはこう書いた方が良いと思います」といったコミュニケーションがよく発生します。

そんなときはGitHubの差分のサジェスション機能を使うと、そのままコミット可能な差分を作成できるので便利です。

An image from Notion

このエントリでは、GitHubのサジェスション機能を簡単にご紹介します。

サジェスション機能の使い方

サジェスション機能の使い方は簡単で、コメント時に下記のようにブロックコード (```) に続けてsuggestionと書くだけです。

An image from Notion

プレビューを見るとわかるように変更の差分がコメントできます。

An image from Notion

PRのオーサーが変更を受け入れる場合はボタンでポチッとするだけでよく、変更を受け入れるとコミットのオーサーと変更を提案したユーザーとの共同コミットが作成されます。

「ここを修正してください」「わかりました。修正します」といったコミュニケーションや、その後ローカルで差分を作ってコミットしてpushしてまた確認してもらって…という手間が省けて良い感じです。

以上です。

このエントリでは、GitHubのサジェスション機能を簡単にご紹介しました。

サジェスション機能を使って普段のコミュニケーションを円滑にしましょう。

タグ