Github을 통한 개발 협업을 한다면, Pull Request는 거의 필수적이라고 할 수 있습니다.
PR을 잘 활용한다면, 코드 병합할 때 동료와 코드를 검토하고 기록하며 변경 이력을 잘 관리할 수 있다는 이점이 있는데요. 혹여나 잘못 운영되기 시작하면, 오히려 개발자들의 시간을 많이 빼앗기도 하고 형식적인 리뷰 활동이 될 수밖에 없습니다.
개인적으로는, PR의 코드 단위와(사이즈가 너무 커지지 않게) 중요한 것들을 잘 기록하고(수정 사항 이력 관리), 충분한 리뷰(+ 적절한 리뷰어 선정)가 필요하다고 생각합니다.
이번에 소개된 글에서도 개발자의 입장에서 PR이란 무엇인지, 좋은 PR을 어떻게 해야할지에 대한 고민을 엿볼 수 있었는데요. 아래는 본문의 제시된 '좋은 PR에 위한 가이드'는 무엇이 있을지 요점만 정리한 것입니다.
✅ 좋은 PR하는 방법
1. 리뷰어 배려하기
- 코드 컨벤션을 잘 지킬 것
- 리뷰 가이드라인 잘 작성하기
- 작업 중, 리뷰 가능 여부를 잘 명시하기
2. 내가 쓴 코드는 내가 책임져라
- 자신이 작성한 코드에 대해서는 100% 이해하라
- 무엇을 알고 무엇을 모르는지를 명확히 해라
3. 반드시 테스트하라
- 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 한다.
4. 자신의 예상 작업량을 잘 측정하라
- 잘 재고, 잘 쪼개기
- 이슈 베이스 브랜치를 활용하라
요점에 더 자세한 설명을 참고하고 싶다면, 본문 글을 방문하여 꼭 확인해 보시길 바랍니다!
좋은 PR에 대한 단상🤔
이 글을 쓰게 된 이유
medium.com
