코드 리뷰 하기

시작

github내 repository를 이용하는것은 형상 관리하는데 가장 중요한 요소입니다. 

이 과정에서는  협업을 수행하는데 팀원들과 함께 코드 리뷰는 어떻게 할지에 대해

아는 범위 내에서 pull request 그리고 merge 단계에 대해 알아보겠습니다.

(2021년 6월 일 마지막 업데이트)

 

Commit & Push

가장 기초가 되는 Commit 과 Push는 해당 링크를 참조하였습니다. https://tagilog.tistory.com/377 

[GITHUB 사용법] 왕초보를 위한 깃허브사용법 (Git사용법)

일반적으로 Master에서 Branch로 하나 생성 해 자신의 workspace를 관리하게 됩니다. 

feature/<name> 으로 branch를 하나 만들어서 commit과 push를 수행합니다.

여기서 branch와 master가 서로 구조가 달라지게 되면 Compare & pull request 항목이 나오는데 이것을 클릭해줍니다.

 

Open a pull request

여기서 보통 커밋한 내용이 제목으로 올라가게 됩니다. 

그리고 현재 작업의 단계는 branch에 있는 내용을 master로 merge 하는 단계입니다. 

Write에는 팀마다  컨벤션에 따라 작성하면 됩니다. 

 

# 토픽 OOO

## 개요
### 🔥 OOO

## 모두에게 물어보고 싶은 궁금한 점 
🤔

 

으로 컨벤션을 잡았습니다. 

 

Labeling

라벨은 기존에 있는 것을 사용해도 되고 개인이 직접 커스터마이징해서 사용해도 됩니다.

스터디 목적으로 사용할 생각으로 맛에 초점을 두어 라벨링을 수정하였습니다.

오른쪽에 라벨을 추가하였습니다. 

그리고 하단에 create pull request를 클릭하였습니다.

 

Create pull request

Create pull request를 클릭하게 되면 Merge 단계 전인 Review 단계에서 잘못된 부분은 없는지 확인하게 됩니다. 

+는 새로 추가된 부분이고 -는 빠진 부분입니다.

 

만약 어느 부분에 대해 의문이 생기거나, 잘못된 부분을 발견했을 경우

몇번째 라인 줄에 보이는 + 부분을 클릭하면 됩니다.

클릭하게 되면 리뷰할 수 있는 박스가 생기는데 여기에 의견을 작성하고 Start a review 를 클릭하면 됩니다.

 

보통의 경우 Pending으로 처리되는데 이건 혼자만 볼 수 있는 리뷰입니다. 

그렇기 때문에 오른쪽 위에 Finish Your Review를 클릭하게 되면 모두에게 보여지는 Review가 작성 됩니다. 

자문자답

 

클릭하면 리뷰가 레포지토리에 소속된 사람들에게 공개됩니다.

이후 레포지토리의 관리자가 request를 허용해주게 되면 master 브랜치로 Merge가 이루어집니다.