Github - Branch Rule & PR Approve

Branch Rule

• Branch Protection rule
  
  1. Branch name pattern 에 규칙을 적용하고자 하는 Branch 명을 입력한다.
  2. Protect matching branches 에서 가장 상단의 Require a pull request before merging 을 꼭 체크할 것!
  

✨ 위의 결과

• main branch로 바로 push 했을 경우 error 발생
• 따로 Branch를 만들어 PR을 날리도록 함
• administrator만 merge가 가능함
• 강제로 코드리뷰를 의무화함
• 무분별한 Merge, Push를 방지

administrator 이란, repository를 생성한 user를 의미함

PR 작성법

1. PR 제목을 입력한다. (저는 보통 커밋 메시지 제목과 동일하게 하는 편..😊)
2. 코드리뷰를 위해 필요한 내용 및 작업사항 등을 PR 내용에 적어줍니다.
3. Reviewers를 한명이상 넣어줍니다. (위의 Branch Rule이 적용되었을 경우는 필수, 그 외는 선택)
4. Assignees와 Labels도 상황에 맞춰 넣어줍니다.
5. Create pull request 버튼을 누릅니다.
   
   

Code Review 작성법

1. 내가 보고자 하는 PR 상단의Files changed의 변경된 코드 내역에 들어갑니다.

2. Review changes 버튼을 클릭해 코드리뷰를 남깁니다.
   

3. 특정 위치의 코드에 comment를 남기고 싶을 경우, 해당 위치의 코드에 마우스를 올려 + 버튼을 사용하면 리뷰를 남길 수 있습니다.
   

4. Comment를 남기고 Start a review 버튼을 클릭해 review를 저장합니다. (직접 해보며 테스트 하는 것을 추천)
   

5. 코드리뷰가 모두 완료되면 우측 상단의 Finish your review 버튼을 클릭해 자신의 리뷰를 등록합니다.
   

6. 이런 방식으로 PR에 대한 코드리뷰를 하며 팀원간의 소통을 합니다.
   (모두 반영이 되거나 확인이 끝난 리뷰는 Resolve conversation 을 눌러 해결처리 합니다.)

✨ 위의 결과

• 팀원간 코드의 충돌을 줄여 개발이외의 시간 소요를 줄일 수 있음
• 팀에서 일어나는 일을 모두 공유해 팀웍을 높임
• 모두가 볼 수 있다는 차원에서 상호 책임감 증대, 지식/해결책 공유로 인해 배움의 기회 및 동기부여 가능
  
  

Approve 방법

• 위에서 적용시킨 Require a pull request before merging 이란 Rule에 의해 특정 reviewer의 승인이 필요할 경우, 승인을 통해 merge를 가능하게 합니다.
• 승인하는 방식은 코드리뷰 방식과 유사합니다.
• 우측 상단의 Finish your review 혹은 Review changes 버튼을 클릭한 후, Comment가 아닌 Approve 토글 버튼을 클릭한 후 Submit review로 제출합니다.
• 이렇게 승인된 PR일 경우, 이후 merge가 가능하게 됩니다.

☔ 승인 전

🌈 승인 과정

🔅 승인 후

체계적인 의사소통 과정을 통해 효율적인 협업을 이룰 수 있습니다! 😊