PR 작성하기

dlgnswk·2024년 2월 27일

PR은 중요하다

바코 프리코스 과제 리뷰에서 ken 님이 PR에 대해 말씀해주셨다.
꽤나 많은 분들이 PR에 대해 알고 있는것 같아서 이번 기회에 구글링을 통해 공부해보려고 한다!

PR은 Git을 통해 협업을 할 때 머지를 하기 전 확인을 받는(Review 하는) 절차라고 한다.
ken 님은 Team project 이기 때문에 혼자의 판단으로 진행하지 않고 팀원들과의 소통인
PR을 진행하는 것이 중요하다고 말해 주셨다!

내가 작성한 코드를 팀원들에게 보여주고 리뷰를 통해 발전해 나가는 방법이라고 볼 수 있다.

PR을 자주, 빨리

LINE QA 엔지니어님이 작성하신 글에서 한시간에 300줄 정도의 코드 리뷰 할 때
결함이 발견되는 비율(inspection rates)이 제일 좋다고 하셨다.

적절한 양을 가능한 자주, 빨리 PR 하는것이 가치 있는 코드리뷰가 될 것이다.

출처 https://engineering.linecorp.com/ko/blog/effective-codereview

(다른 리뷰어가 피로해 하지 않도록 적절한 양을 조절하여 PR하는 것이 중요하다..!)

PR 작성하는 방법

PR 작성 방법에는 여러가지 방식이 있는 것 같다.
구글링해보니 팀 또는 개인마다 각자 맞는 템플릿을 정해 사용하고 있었다.

Github에서 제공하는 PR Templates 첫번째 예시
Github에서 제공하는 PR Templates 두번째 예시
`링크` https://github.blog/2016-02-17-issue-and-pull-request-templates/

내가 괜찮다고 생각한 템플릿들

첫번째,

개요 🔍

어떤 이유에서 이 PR을 시작하게 됐는지에 대한 히스토리를 남겨주세요.

작업사항 📝

해당 이슈사항을 해결하기 위해 어떤 작업을 했는지 남겨주세요.

테스트 방법(optional)

리뷰하는 사람이 어떻게 테스트할 수 있을지 간략히 써주세요.

이렇게 볼 수 있다.

링크 https://another-light.tistory.com/71

두번째,

PR 타입(하나 이상의 PR 타입을 선택해주세요)

-[] 기능 추가
-[] 기능 삭제
-[] 버그 수정
-[] 의존성, 환경 변수, 빌드 관련 코드 업데이트

반영 브랜치

ex) feat/login -> dev

변경 사항

ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.

테스트 결과

ex) 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린샷, GIF, 혹은 라이브 데모가 가능하도록 샘플API를 첨부할 수도 있습니다.

링크 https://velog.io/@ye-ji/Git-PR-%EC%9E%98-%EC%93%B0%EB%8A%94-%EB%B0%A9%EB%B2%95

세번째,
- Summary (내가 뭘 했는지)
- Needs more than 10 min for review? (리뷰하는데 10분 이상 걸리는가? 걸린다면, 얼마나 걸릴지)
- Before i request PR review, (내가 PR 리뷰 부탁하기 전에 한 일.
  예를 들면 개인 테스팅 환경에서 케이스들을 확인해봤다거나 test code를 run 했을 때 모두 통과했는지)
- After this PR reviewed,
  (PR 리뷰가 끝난다면 뭘 해야 하는가? Merge 전 필요한 Process들.
  예를 들면 DB 컬럼을 추가한다거나 Table을 만들어야 한다거나의 일들)
  
  링크 https://bluayer.com/29