Beeeat’s log

Beeeat’s log

プログラミングで出くわした知識やツール、日常生活、働き方その他色々なことをメモしていくブログ

GitHub の suggestion 機能を使って提案されたコードを取り込む

GitHub のプルリクエストでチームメンバーへコードレビューを依頼した際に suggestion 機能を使ってソースコードで具体的に提案されることがある.

※下記は都合上,サンプル用のリポジトリで自分のプルリクエストに自分で提案をしている.

f:id:bake0937:20200817221926p:plain

実は今までここまでしか使っていなかったのだが,提案されたコードを取り込むができることをチームメンバーから聞いたため,今回はそれについてまとめていく.

コードを取り込む2つの機能

Commit suggestion

suggestion したコメントの下にある「Commit suggestion」ボタンを押すと,なんとコミットメッセージを入力することができる.

f:id:bake0937:20200817222446p:plain

「Commit changes」を押すと下記のようにコミットされた状態になる.

f:id:bake0937:20200817222628p:plain

Add suggestion to batch

取り込む方法はこれだけではない.下記のように複数の提案箇所を一つのコミットにまとめたい場合は「Add suggestion to batch」が便利.

f:id:bake0937:20200817222906p:plain

Add suggestion to batch を押すと,このように Commit suggestions が貯まっていく.

f:id:bake0937:20200817223056p:plain

ある程度のまとまりになったら Commit suggestion を押し,コミットメッセージを入れ,Commit changes を押す.

f:id:bake0937:20200817223324p:plain

するとこのようにコミットされた状態になる.

f:id:bake0937:20200817223604p:plain

まとめと所感

今回は GitHub の suggestion 機能を使って提案されたコードを取り込む方法についてまとめた.

今まではチームメンバーから提案されたコードや自分で見つけた改善案のコードをローカルリポジトリで コミットと push をしていた. しかし,これからはそれらの作業を GitHub 上でササッとできるのは確かに便利だと感じた.

この機能をうまく活用し,チームメンバーからのフィードバックを上手く取り込んでいくと,開発スピードが更に上がりそうだ.