Git

GitHub로 코드 리뷰하기

luckjjh 2022. 4. 24. 00:11

원활한 피드백을 위해 GitHub로 코드 리뷰를 하는 방법을 알아보자 🧑‍💻

 

1. 레포 복사해서 갖고오기 (Repository clone)

 

코드 리뷰는 다른 팀원들이 작성한 코드를 보고 주석을 통해 리뷰를 남기는 방식으로 진행된다. 그렇기 때문에 리뷰를 할 Repository의 파일을 따로 PC에 저장해야한다.

 

Reopsitory 초록색 Code 버튼 클릭

 

초록색 Code 버튼 클릭 후 Clone URL 복사

 

Clone할 Repository를 저장할 폴더를 하나 생성한다.

 

생성한 폴더에서 우클릭해서 git bash 실행

git clone {복사한 URL}

git bash 실행 후 위와 같이 입력해 준다. 

cf. Window 기준 git bash에서 복사는 shift+insert 이다.

 

이런식으로 폴더에 Repository 이름을 갖는 폴더가 생성되면 성공이다.

 

 

2. Branch 생성하기

복사한 레포에서 코드리뷰 작업을 수행하고 해당 내용을 add, commit, push 하게 되면 다른 사람이 올린 원본 코드가 수정이 되기도 하고 여러명이서 리뷰를 하게되면 서로 작업하는 파일이 겹쳐 충돌이 일어날 수도 있음으로 Branch라는 개념을 사용할 것이다.

 

Branch
여러 사람이 동일한 소스코드를 기반으로 서로 다른 작업을 할 수 있게 만들어 주는 기능으로 원본 코드에 영향을 끼치지 않으면서 각자 동일한 코드를 독립적인 영역에서 변경하는 것이 가능하다.
그림처럼 branch를 생성하게 되면 main branch와 평행한 직선이 하나 더 생기게되고 생성된 직선과 main branch는 평행하기 때문에 서로 영향을 주지 못한다.

앞서 Clone한 레포 폴더로 들어가 git bash를 실행하고 명령어를 입력한다.

git branch {브랜치 이름}

브랜치 이름은 원하는 이름으로 입력해 주고, 명령어를 입력하게 되면 해당 이름을 갖는 branch가 생성된다.

 

하지만, branch를 생성하기만 했을 뿐 현재 사용하는 branch를 main branch이기 때문에 branch를 변경하는 명령어를 입력해야 한다.

git checkout {브랜치 이름}

해당 명령어에 앞서 생성한 branch의 이름을 입력해주면 생성한 branch가 선택된다.

 

branch가 정상적으로 선택되었는 지 확인하기 위해서는 

git branch

명령어를 입력하면 된다.

선택한 branch에 * 표시가 되어있는 것을 확인 가능하다.

 

3. 코드 리뷰하기

Clone한 레포의 폴더에서 코드 리뷰를 진행할 파일을 열고 주석이나, txt, readme.md 문서를 생성해 코드 리뷰를 진행하고 평소 commit을 할때 처럼

git add .
git commit -m "커밋 메세지"
git push

명령어를 입력해주면 된다.

 

커밋이 완료되면 

이렇게 생성된 branch에 리뷰한 코드가 올라간 것을 확인할 수 있다.

 

 

cf. 원래 GitHub에서의 코드리뷰는 팀 프로젝트를 진행할 때, 각자 담당한 파트를 구현하고 구현한 내용을 main branch에 병합하기 전에 기존 코드와 변경된 코드를 확인하며 의문이 가는 부분, 개선할 여지가 있는 부분을 서로 피드백하고 리뷰가 완료되면 main branch에 해당 내용을 병합하는 방식으로 진행된다고 한다.

하지만, 우리는 개인이 진행한 프로젝트에 대해서 서로가 작성한 코드를 보며 많은 코드를 접하고 개선할 부분 찾고, 개선해주는데 목적이 있기 때문에 따로 pull request를 생성해 main branch에 병합하는 과정까지는 하지 않는 것이 좋을 것 같다.

'Git' 카테고리의 다른 글

GitHub 공용 레포에 Pull Request로 코드리뷰를 해보자  (0) 2022.04.26