📄코드 리뷰 하는 방법

리뷰 기다리는 중 🔥 라벨이 붙은 PR을 잽싸게 찾아줍니다.

문제 링크에 들어가서 어떤 문제인지 빠르게 확인한 뒤, 작성자가 작성한 수도 코드를 읽어본다.

수도 코드를 다 읽었다면, 상단으로 올라와서 Files changed에 들어간다.

코드를 읽다가, 궁금한 부분이나 칭찬하고 싶은 부분, 새롭게 얻어가는 부분이 있다면

아래 사진처럼 빨간 네모 박스 안에 + 버튼에 드래그를 하면 해당 코드 블럭에 코멘트를 남길 수 있습니다.

코드 리뷰 잘 하는 법을 참고해보면 좋을 것 같다...! 😊😊

이 때, Add single comment 가 아닌, start a review로 해줍니다.

Add a single comment로 할 경우 코멘트 하나하나 마다 해당 PR작성자에게 알림이 가요. 🥲🥲🥲

코드에 코멘트를 다 남겼으면, 우측 상단에 Review changes를 눌러줍니다.

마지막으로 해당 PR에 대한 마무리 멘트를 날려줍니다. 그리고 Approve에 체크 후, submit Review를 눌러줍니다.

Commnet는 해당 PR에 피드백을 줄 때 사용합니다.

Approve는 해당 브랜치의 PR을 Main 브랜치로 병합하는 데 승인한다는 뜻 입니다.

Request Changes는 해당 PR에서 수정할 부분이 있을 때, 수정을 요청하는 뜻 입니다. 즉 이 것을 체크하면 병합을 승인하지 않는다는 뜻입니다.

저희는 단지 스터디이므로, Approve외엔 딱히 사용할 게 없습니다.

Approve를 했다면, Reviewers에서 자신의 아이디 옆에 ✔️로 바뀜을 볼 수 있습니다.

마지막으로, 내가 해당 PR의 마지막 리뷰어라면 (나를 제외한 2명이 모두 리뷰를 남기고 내가 3번째 라면) 상단으로 올라와서,

코드 리뷰 기다리는 중🔥 라벨을 리뷰 완료 ✔️ 라벨로 바꿔줍니다.

이 때 자기가 올린 PR이 아니라면 절대로 마음대로 Merge하지 않습니다.

만약, 자신의 PR이 다른 스터디원의 리뷰를 모두 받아서, 리뷰 완료 ✔️ 라벨이 되었다면,

잽싸게 나의 PR로 들어갑니다.

해당 PR의 코멘트를 확인한 후 답글이 필요한 코멘트는 답글을 달아줍니다.

달만한 코멘트를 다 달았다면, 맨 아래로 내려와서 Merge Pull Request 를 눌러주면 끝 입니다.

추가적으로, Github 우측 상단에 박스 모양 알림표시가 뜨면,

자주 자주 확인해줍니다.

나와 관련된 PR에 코멘트가 달린 것을 바로 확인할 수 있습니다..!

++추가적으로 Merge되어 Closed된 상태의 PR도 코멘트를 남길 수 있습니다.

그러니 라벨이 변경되었으면 그냥 Merge해주시고, 닫힌 PR에서 또 대화를 이어나가시면 됩니다.

긴 글 읽어주셔서 감사합니다. 😊😁😊😁

write by : tgyuuAn

Provide feedback