Git Pull Request란?
원격 저장소의 특정 branch에 push 하고 나면 프로젝트 관리자에게 이 내용을 알리고 병합을 요청하는 것을
Pull Request라고 한다.
Git Pull Request 컨벤션
아래의 깃허브 공식 블로그 글을 참고했다.
How to write the perfect pull request
- PR의 목적을 한문장으로 요약하기
- PR을 생성하게된 맥락이 있는데 이를 리뷰어가 알아야 한다면 함께 명시
- 피드백 받기를 원하는 시점을 명시
- 요청한 PR이 작업중이라면 리뷰어들이 알 수 있도록 '작업중' 혹은 'WIP(Work In Progress)' 라고 기재
- 원하는 피드백의 방향과 내용을 리뷰어가 알 수 있도록 명시
- 짧은 답변이라도 어조를 명확히 하기 위해 이모지 사용
피드백에 응답하는 방법
- 피드백에 대한 감사의 표현
- 이해가 안됐을 경우 리뷰어에게 명확히 표현 할 수 있도록 이끌어내기
- 문제 해결법 피드백에 대한 응답이라면 그 해결법에 도달하기 위해 내린 결정에 대해 설명
- 최대한 모든 피드백에 대해 응답
- 혼란이나 논쟁이 증가하고 있다면 쓰여진 단어가 의사소통에 좋은건지 검토
- 항상 코멘트로 해결하기 보다는 화상회의나 오프라인 토론 후 요약글을 게시하는 것도 고려
실제 적용한 프로젝트 링크
전반적 효과
컨벤션으로 협업과 리뷰 프로세스에 도움을 주며 맥락과 함께 기록이 남기에 유지보수를 좀 더 용이하게 해줄 수 있다.
PR은 결국 글쓰기와 글읽기로 리뷰 목적의 커뮤니케이션이 핵심이기 때문이다.
'Git' 카테고리의 다른 글
| Git 커밋 메시지 컨벤션 (2) | 2021.03.26 |
|---|---|
| Git을 사용하기 위해 알아야 할 개념과 명령어 (0) | 2021.03.20 |