Help us understand the problem. What is going on with this article?

[GitHub] まだ PR レビューで『typo』ってコメントしてるの?(Suggestion機能で修正提案する)

Tl;Dr

Suggestion(Cmd + g) で修正提案のコメントができ、
308E350C-20B2-4B48-B563-C23C53DC5869.png

取り込む人は diff を確認し、 Commit suggestion からボタン一つでコミットして取り込める。
7D9AF6A1-B320-40B3-97C7-0D82BBB98B85.png

追記:2020/02/27
まだ、ベータ段階だが複数行の修正提案にも対応された。
image.png

Suggestion Change

冒頭のようにsuggestionをつけたコード形式で記述すると、修正提案という形でコメントできる。

単純なtypoであればこのままコメントしても伝わるだろうし、補足したいことがあれば冒頭のように説明を追加することも出来る(これが適切な例かは別として)。

取り込む人は diff を確認してボタン一つでコミットできるし、レビュアーは自身のコメントが取り込まれていることを確認するだけでよいので、双方の負担軽減につながる。

コミットをまとめる

特に Push トリガーで CI を実行している場合において、複数の修正提案を一つずつコミットすると、コミット単位で CI が実行されてしまい煩雑なことがある。

その場合は Add suggestion to batch からコミットをまとめることができ、
CF21E86F-C549-45B9-B6F1-C68318730BBF.png

Commit suggestions からコミットできる。
728E231B-A62D-4166-AFBB-DC3F34B8E87D.png

補足

この機能に限った話ではないが、リモート側でコミットされるので、ローカルでも合わせて修正をする場合は git pull するのを忘れないようにする必要があるので注意。

もし修正がコンフリクトしないなら git pull --rebase が手っ取り早い。

終わりに

この内容に相当する記事は、半年くらい前に会社の Qiita::Team でも書いており、Qiita にも書こうと思いながら半年以上も経過してしまった;

レビューイ・レビュアーの双方の負担を減らす、良き PR レビューライフを。

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした