PR 리뷰하는 법은 이 두 글을 참고해 공부했다.
https://devlog-wjdrbs96.tistory.com/231
https://xo.dev/articles/github-collaboration-guide
Comment와 Review 달기의 차이점
PR 리뷰를 하는 과정을 찾아보는데 둘의 차이점에 대해 궁금함이 생겼다.
이렇게 앞에 있는 + 버튼을 누르면 해당 줄의 아래에 코멘트 창이 생기는데 comment 달기와 review 달기 둘에는 무슨 차이가 있을까?
결론부터 말하자면
comment와 review 모두 comment이다. 다만 등록되는 시기와 알람 여부가 다르다.
- comment는 제출하면 바로 등록되고, 매 등록마다 알람이 울린다. 여러 줄을 리뷰해야 한다면 추천하지 않는다.
- review는 pending(지연) 됐다가 상단에 있는 Finish review 버튼을 누르면 한번에 등록된다.
Add single comment
comment로 리뷰를 할 수도 있다. 다만 comment로 제출하는 순간 관련자들에게 알람이 간다.
해당 줄에 대해 개별적으로 알람이 가게 하고 싶거나 리뷰할 게 별로 없을때는 이렇게 달아도 되지만 별로 추천하지 않는다. 코멘트 달았다가 삭제했다가 할 수도 있는데 그때마다 알람이 가면 별로다.
Start a review
이건 review로 달은 것이다. Pending 표시가 뜨는데, 아직 등록되지는 않고 내가 보는 화면에만 존재하는 상태이다. 그러므로 아직까지 등록할 때 알람이 가지 않는다. 삭제했다가 등록했다가 맘편히 할 수 있다.
이게 여러 개 달리면 상단에 있는 review 전체 끝내기 버튼에 있는 숫자가 올라간다.
리뷰 마치기
싱글 코멘트를 달든, 리뷰를 달든 현재 PR에 대한 리뷰를 마치는 단계이다. 상단에 있는 Finish your review 버튼을 클릭하면 현재 리뷰들에 대한 종합 리뷰를 할 수 있다.
종합 리뷰 코멘트에서는 현재 PR에 대한 총평이나, 리뷰를 마쳤다, 수고했다는 식의 말을 하면 된다.
또한 현재 리뷰에 대한 성격을 지정해 줄 수도 있다.
- Comment - 단순한 리뷰인지,
- Approve - 현재 PR을 merge하는 것을 승인한다는 리뷰인지,
- Request changes - 수정 사항이 있어 merge할 수 없다는 리뷰인지
등록을 한다. 그러면 아까 달았던 review에서 pending이 사라지고 리뷰한 사항이 업로드 된다.
