Git

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

luckjjh 2022. 4. 26. 00:41

1. 레포 clone하기

작성한 코드를 올릴 레포에 접속하고 1번 박스를 누른 뒤 2번 박스를 눌러 URL을 복사한다.

 

새폴더를 원하는 곳에 생성하고 해당 폴더에서 git bash를 실행한다.

 

실행된 git bash에 아래 명령어를 입력해준다.

git clone {복사한 URL}

이런식으로 레포가 폴더에 복사되면 성공!

2. 새로운 Branch 생성하기

이제 복사된 레포 폴더로 들어가 다시 git bash를 실행시키고 아래 명령어를 순서대로 입력해준다.

git branch {브랜치이름}
//브랜치를 생성하는 명령어. 이름은 자유롭게 작성해도 된다.
git checkout {브랜치이름}
//앞서 생성한 브랜치를 선택하는 명령어
git branch
//생성한 브랜치가 잘 선택되었는지 확인가능한 명령어

명령어가 성공적으로 입력되었다면 위 사진처럼 생성한 브랜치 앞에 '*' 표시가 나온다.

 

3. 코드리뷰 받을 작업물 올리기

이제 공용레포 폴더 안에 있는 개인 이름 폴더로 들어가 코드리뷰 받을 작업물을 복붙해준다.

!!!!여기서 주의할 점 개인 이름 폴더에 작업물 폴더를 통으로 올리면 안되고 파일들을 올려줘야한다!!!!

작업물 복붙이 완료됐으면 다시 공용레포 폴더로 돌아와 git bash를 실행시키고, 아래 명령어를 입력해 git에 작업물을 업로드한다.

git add .
git commit -m "커밋 메세지"
git push origin {생성한 브랜치 이름}

이런 식으로 나오면 업로드 성공!

4. Pull Request 하기

commit을 완료하고 공용레포로 가보면 아래 사진처럼 연노란색 탭이 하나 생긴것을 확인할 수 있다.

여기서 'Compare & pull request' 버튼을 눌러 pull request 생성 화면으로 넘어간다.

 

이 화면으로 넘어오게 되면 "base: main, compare: 생성한 브랜치 이름" 이런 식으로 되있는 것을 확인할 수 있는데 이 표시는 코드 리뷰가 끝나면 생성한 브랜치에서 작업한 내용을 main으로 병합하겠다는 의미이다.

 

브랜치가 잘 설정되어 있는 것을 확인했으면 이제 리뷰를 부탁할 사람을 지정해줘야 한다.

빨간줄이 그어진 부분을 누르게 되면 아래 사진처럼 공용레포 구성원들이 나오게 된다.

 

여기서 리뷰를 부탁할 구성원들을 선택하고 Leave a comment 부분에는 코드 어떤 부분을 중점적으로 리뷰했으면 좋겠는지에 대해 작성하면 된다.

 

앞선 내용들을 모두 작성하고 빨간색 밑줄쳐진 버튼을 누르면 pull request가 생성된다.

 

이런식으로 pull requests가 생성되면 성공!

pull request가 생성되었다면, 이제 구성원들의 코드 리뷰를 기다리면 된다!

 

5. 코드리뷰하기

리뷰를 요청 받았다면 공용레포 pull requests 탭을 누르고 요청받은 pull request로 들어가면 된다.

pull request에 들어온 후 Files changed 탭을 누른다.

 

이제 여기서 코드리뷰를 시작하면 된다.

 

Example

1. 리뷰를 하고 싶은 부분 왼쪽 + 버튼을 클릭한다.

 

2. '+' 버튼을 누르면 나오는 탭에 코드리뷰를 작성한다.

 

버튼을 누르게되면 아래 사진처럼 댓글형식으로 리뷰가 작성된다.

 

3. 리뷰를 다 마치면 우측 상단에 Review chages 버튼을 누르고 전체적인 감상평을 남긴다.

감상평을 남기고 Submit review를 누르게 되면 코드리뷰를 마치게 된다.

 

6. 마무리

구성원들에게 코드리뷰를 모두 받았으면 이제 main branch와 리뷰를 받은 branch를 병합해줘야한다.

 

공용 레포에서 내가 생성한 pull request를 선택한다.

 

pull request에서 빨간색 줄로 친 Merge pull request 버튼을 누르게 되면 

이런식으로 화면이 나오고 Confirm merge 버튼을 누르게 되면

main branch에 코드리뷰를 받은 작업물이 병합되게 된다!

'Git' 카테고리의 다른 글

GitHub로 코드 리뷰하기  (2) 2022.04.24