PIYO - Tech & Life -

GitHubのsuggestion機能でプルリクエストのレビュー中にコードを提案できるらしい

GitHub

というのをTwitterで見かけたので試してみました。

プルリクエストのレビュー欄で案内が出るので見たことがある人も多いかもしれません。

検証のため、本当に雑なプルリクエストを作って試しました。コードに意味はないので気にしないでください。

suggestion機能の使い方

suggestion機能は、プルリクエストのレビューをしていて、「ここのコード、こっちの書き方のほうがいいよとか、こっちの書き方じゃないとまずいよ」というときに、コードの差分をまるっと書いてあげるとそのまま取り込める、みたいな機能です。

suggestionを作る

プルリクエストのコメント欄のここ(↓)にボタンがあります。

これを押すと、

```suggestion
// code
```

みたいなテキストがコメント欄に挿入されます。ここに、どのように元のコードから変えたほうがいいのか、みたいなことを書きます。

たとえば画像の例ではletをconstに変えようという指摘をしています。

```suggestion
let dummy = 'dummy text';
```

最初↑のように挿入されたものを↓に書き換えてコメントを登録します。

```suggestion
const dummy = 'dummy text';
```

すると差分つきのコメントになります。Resolve conversationボタンやApply suggestionsボタンもありますね。

suggestionを適用しない場合

議論した結果やっぱりこの差分使わない、となった場合はコメント左下にあるResolve conversationを押せばOK。suggestionは畳まれるのでそのあとあまり邪魔にはなりません。

差分そのままじゃなくて自分でもうちょっと直すというときもResolveしそう。

suggestionを適用する場合

差分をまるっと取り込みたい場合はApply sugggestionsします。コミットメッセージをつけてコミットができます。

コミットすると、プルリクエストの元ブランチに新しいコミットとして追加されます。

という感じでした。

これ結構使えそうだー。