PR이란 무엇인가?
- 깃허브 레퍼지토리에 있는 브랜치에 푸시한 내역들, 변경된 사항들을 다른 사람들에게 알리는 것
- 마스터 브랜치에 merge되기 전, 변경된 사항에 대해 다른 사람들과 논의, 검토할 수 있음
- 자연스러운 코드 리뷰를 할 수 있다.
- 오픈소스 프로젝트에 기여할 수 있다.
- PR을 하면 merge 전에 코드를 확인할 수 있고 각 코드별로 코멘트를 달 수 있다.
- 코드 안정성을 높일 수 있다.
좋은 PR은 무엇인가
PR의 규모를 적당히 가져가기
- PR의 규모가 너무 크면 reviewer와 reviewee 모두가 힘들어진다
- 보통 1개의 PR이 1000줄을 넘지 않게 정함
Reviewer 배려하기
- 코드 컨벤션 잘 지키기.
- 리뷰 가이드라인 잘 작성하기
- 작업 중 리뷰 가능 여부 잘 명시하기
내가 쓴 코드 책임지기
- 자신이 작성한 코드에 대해 100%이해하기
- 무엇을 알고 무엇을 모르는지를 명확하게 하기
반드시 테스트 하기
자신의 예상 작업량 잘 측정하기
- 잘 재고, 잘 쪼개기
- 이슈 베이스 브랜치 활용하기
유용한 PR의 양식
# 주요 변경사항
- 이 PR이 해결하는 문제
# 링크
- 디자인 시안 링크 / 슬랙 관련 대화 링크
# 시급한 정도
- 보통
- 긴급
- 천천히
# 중점적으로 봐줬으면 하는 부분
- 변경사항이 큰 경우 집중해야 할 부분, 또는 불안해서 봐주었으면 하는 부분 등
출처
좋은 PR 작성하기