[특강] Git & PR(2)

학습 내용

1. Git 개념 및 프로젝트 적용

2025.02.13 - [분류 전체보기] - [특강] Git & PR(1)

2. Github을 통해 Pul Request 사용법

 

 

Pull Request 란 코드 변경 사항을 병합 요청하는 행위이다.!

병합 전 팀 컨벤션에 따라 변경 내용을 검토하고 토론할 수 있다.

저희 팀은 main PR 할 때, 1명의 필수 승인자 옵션을 추가했습니다.

 

적절한 PR 단위

• commit 단위로 바로바로 피드백 받으면 좋으나 초기 개발 과정에서 많은 커밋 단위가 생성되므로 적절하게 팀 컨벤션을 정하는 것이 좋다.
• commit 단위는 기능 단위로 하면 리뷰어들이 PR을 쉽고 빠르게 이해할 수 있어서 가장 작은 단위로 올리는 것이 좋다.

 

1. 이번 프로젝트에서 처음으로 GitHub PR Template 사용하여 PR 을 진행하였다.

참고: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Creating a pull request template for your repository - GitHub Docs

• 프로젝트 하위 .github 숨김 폴더에 pull_request_template.md 파일을 생성하여 먼저 target 브랜치에 반영합니다.
• 이후 source → target 으로 PR 시 해당 템플릿이 적용됩니다. 

## 변경 타입
- [ ] 신규 기능 추가/수정
- [ ] 버그 수정
- [ ] 리팩토링
- [ ] 설정
- [ ] 비기능 (주석 등 기능에 영향을 주지 않음)

## 변경 내용
- **as-is**
  - (변경 전 설명을 여기에 작성)

- **to-be**
  - (변경 후 설명을 여기에 작성)

## 코멘트
- (추가적인 설명이나 코멘트가 필요한 경우 여기에 작성)

 

2. PR에 대한 코멘트 작성

꼭 반영되어야하는지에 대한 기준을 명확히 하기 위해 보통 Pn룰을 적용하여 코멘트 규칙을 정의한다고 합니다.

저희는 이번에 뱅크샐러드 코드 리뷰를 참고하여 코멘트를 작성하기로 결정했습니다.

참고: https://blog.banksalad.com/tech/banksalad-code-review-culture/#%EC%BB%A4%EB%AE%A4%EB%8B%88%EC%BC%80%EC%9D%B4%EC%85%98-%EB%B9%84%EC%9A%A9%EC%9D%84-%EC%A4%84%EC%9D%B4%EA%B8%B0-%EC%9C%84%ED%95%9C-pn-%EB%A3%B0

 

3. 문제 해결 및 병합하기

처음으로 코드 리뷰도 진행하기로 했습니다. 리뷰를 확인하고 답변을 남기고 내용을 해결할 수 있습니다.

저희 팀은 main target에 병합 할 때, 1명이 승인해야만 merge pull request를 완료할 수 있습니다. Files changed 탭으로 이동하여 PR를 확인하여 Finished your review 클릭 후, 하단 옵션에서 Approve를 선택하고 Submit review 클릭해야지 Merge pull request 버튼이 활성화 됩니다.

 

 

 

전 프로젝트를 진행할 때, 커밋 메시지 형식을 구체적으로 정하지 않고 진행하고, 커밋 단위를 가장 작은 기능별 단위를 쪼개지 않고 개발하여 어떤 파일이나 코드에서 문제가 발생했는지 확인하는게 어려웠습니다.

코드 리뷰도 그렇고 새로운 것들을 처음 적용해보는 것이라 시간이 오래 소요되고는 있지만 확실히 다른 팀원의 코드를 한눈에 파악하는데 수월할 것 같습니다.