GitHub 사용자 교육 5강 -코드 리뷰-

벌써 낙엽이 지는 가을이 왔습니다. GitHub 사용자 교육도 5번째 시간을 맞이했는데요.

지난 4회 차에서는 풀리퀘스트(Pull-Request)에 대해 알아봤습니다.

​

​

[지난 웨비나]

GitHub 기본 사용법 Webinar 4강 -Pull Request-

이번 웨비나 주제는 코드리뷰(Code Review)입니다.

 

---

코드리뷰란?

코드리뷰란 작업한 소스에 대해 팀원들과 개선점 및 다른 이슈에 대해 논의를 나누는 것입니다. 

코드에 대해 의견을 나눔으로써 지식을 공유하고 더 좋은 코드를 생성할 수 있습니다.

풀리퀘스트가 생성된 시점부터 진행되는 단계입니다.

하지만 코드리뷰를 방해하는 요소가 있는데요. 무엇이 있는지 알아볼까요?

이 그래프는 개발자를 대상으로 한 코드 리뷰에 대한 설문조사입니다. ​

개발자들이 코드리뷰가 쉽지 않은 이유는 일정 부족(35%), 지적에 대한 두려움(22%), 코드 리뷰 하는 방법이 불편해서(17%), 가독성이 떨어지는 코드(15%) 순서입니다. 그래서 코드리뷰를 잘 수행하기 위해서는 일정 확보(29%)가 필요하다는 의견이 가장 많았고 그 뒤를 이어 공감대 형성(27%), 인프라 구축(20%) 등이 뒤를 이었습니다.
그럼 코드 리뷰를 더 잘하기 위해서는 무슨 방법이 있는지 알려드리겠습니다.

 

 

코드리뷰를 잘하는 방법

1. 더 적게 더 자주 작업하기

먼저 코드리뷰를 잘하는 방법으로는 더 적게 더 자주 작업하는 것입니다. 변경된 부분이 많을수록 리뷰어의 참여도가
떨어지고 DevOps 관점에서도 더 자주 작업하는 것이 코드의 품질을 높이는 방법입니다.

​

​

2. 특정 사용자에게 리뷰 요청하기

당연한 말이지만 해당 소스나 프로젝트를 잘 아는 사람일수록 더 좋은 의견을 얻을 수 있습니다. 그래서 특정 사용자에게 리뷰 요청을 하고 또 요청을 받은 사람은 빠르게 피드백을 해주어야 합니다.

​

​

3. 상세하게 주석 작성하기

작업자는 최대한 상세하게 주석을 작성해야 합니다. 그래야 별도 문의 없이 주석만 보고도 어떤 작업인지 바로 이해하고
리뷰를 할 수 있습니다.

​

​

4. 상대방을 배려하기

코드리뷰를 할 때는 상대방을 배려하는 자세로 진행해야 합니다.

​

​

5. 코드리뷰 정책 정하기

마지막으로 각 팀에 맞는 코드 리뷰 정책을 정하는 것입니다. 특정 기준이나 가이드가 있을 때 코드 리뷰는 더욱 활성화될 수 있습니다.

​


코드리뷰 활성화 방법

코드리뷰를 활성화하는 방법은 지난 시간에 알려드린 것처럼 풀리퀘스트 생성 후 특정 사용자에게 리뷰를 요청하는 방법과 브랜치 메뉴에서 최소 리뷰어 수를 설정하는 방법이 있습니다.

 

설정 메뉴에서 브랜치 탭을 선택하시면 브랜치 보호 정책을 보실 수 있습니다. 최소 리뷰어 수를 설정하시면 최소 리뷰어 수를 충족한 경우에만 병합이 가능해집니다.

 

 

 

GitHub에서의 코드리뷰

GitHub에서의 코드리뷰는 풀리퀘스트에서 이루어집니다.

 

 

 

 

Conversation 탭에서 서로 대화를 주고받거나 특정 소스코드를 추가해 코멘트를 추가할 수도 있습니다. 그리고 Files changed 탭에서는 변경된 파일들을 확인할 수 있고 라인별 또는 복수의 라인을 설정해 코멘트를 추가하실 수 있습니다.

 

 

​

​

 

마지막으로 "Review changes"를 누르시면 작성한 코멘트의 상태값을 설정하거나 변경하실 수 있습니다.

 

 

---

이번 웨비나는 여기까지입니다.

웨비나를 보시고 싶으신 분들은 아래의 이미지를 눌러주세요!

 

 

 

다른 궁금한 사항이 있으시면 언제든지 아래에 댓글을 남겨주세요.

그럼 다음 시간에 뵙겠습니다.

감사합니다.