완벽한 pull request를 작성하는 방법
4 min readApr 23, 2021
깃허브 공식 블로그에 좋은 글이 있어 번역을 해보았습니다.
회사가 성장함에 따라, 조직원과 프로젝트 역시 변화합니다.
깃허브에서 우리가 원하는 문화를 만들어가는것을 지속하기 위해서
우리는 우리가 하는 소통의 목적에 대해
인식하는것이 중요하다는 것을 깨달았습니다.
우리는 최근 pull requests를 통해 협업할 때
서로가 최선의 서로가 될 수 있도록 도와주는 가이드라인을 소개했습니다.
Pull request 작성 방식
- pull request의 목적에 대해 포함하고 있어야 합니다.
예)
이 pr은 ~를 탐구하기 위한 시작입니다.
이 pr은 ~의 display를 단순화합니다.
이 pr은 ~의 핸들링을 고칩니다. - 이 작업의 시작에 대한 전반적인 배경상황을 제공하는것을 고려하세요.
(연관된 아무 링크라도 말이죠)
해당 작업의 역사에 대해 모두가 알고있을 것이라고 가정하지 마세요. - 원하는 피드백에 대해서 구체적으로 요구하세요.
(이모지를 통한 리액션, 기술적 토론, 디자인적 비평, 사본 검토 등) - 구체적으로 언제 피드백을 원하는지 표기하세요.
pr이 미완성 상태라면, 그렇다고 표기하세요.
“[WIP]” 과 같이 간단한 prefix를 제목에 붙여
pr의 상태를 인지할 수 있게말이죠. - @mention 기능을 통해 해당 pr에 대해 토론하고 싶은 특정인을 초대하고그 이유에 대해서도 함께 작성해주세요.
예) @홍길동 해당 로직에 대해 설명해주세요~ - 개인뿐만 아니라 팀단위로도 동일한 기능을 사용해보세요.
예) @보안팀 해당 방식에 대해 우려할만한 점이 있을까요?
피드백 제공 방식
- 먼저 해당 이슈의 문맥과
해당 pr의 존재 이유에 대해 이해해야 합니다. - 강한 부정의견이 생긴 경우,
피드백을 남기기 전, 단 1분이라도 멈춰보세요.
즉각적인 감정적 반응은 좋지 않습니다. - 물어보세요. 지시하지 말고.
예) “이렇게 하지마세요" X
=> “이런 방식에 대해서는 어떻게 생각하세요?” O - 해당 코드가 변경되어야 하는 이유를 제시하세요.
( 스타일 가이드를 준수하지 않은 이유가 있을까요? 개인적 취향인가요?) - 코드를 개선하거나 단순화 할 수 있는 방법을 제공하세요.
- 모멸감을 주는 표현을 피해주세요.
누군가의 작품을 칭할때 ‘멍청한' 과 같은 표현을 쓰지 않는게 좋습니다. - 겸손하세요.
예) “저도 확실하지는 않지만, 이런 방식은 어떨까요?” - 과장하지마세요.
예) “절대" 이거 하시면 안됩니다. - 그룹 피드백을 통해 전문적 기술(개발), 조직의 지식과 product quality를 향상하는것을 지향하세요.
- 비대면 의사소통에서 발생하는 부정적 편견에 대해 인지하세요.
( 내용이 중립적일 경우, 우리는 부정적인 의사가 담겨있다고 착각하곤 합니다). 무미건조한 표현대신 긍정적 표현을 사용하는건 어떨까요? - 어조(tone)를 명확히 하기위해 이모지를 사용하세요.
예) 좋습니다 => ✨ 좋습니다👍
피드백에 대한 반응 방식
- 피드백에 대한 감사표현부터 하는것을 고려하세요.
- 애매할 경우, 보다 구체적으로 피드백 해주기를 요청하세요.
예) “저는 이해를 못하겠어요, 조금 더 자세히 얘기해주실 수 있을까요?” - 해당 요청을 받은 경우, 보다 구체적으로 설명을 제공하고,
제공한 피드백의 이유를 설명하세요. - 모든 코멘트에 응답하려고 합시다.
- 후속 커밋이나 pull request가 있다면, 링크를 걸어주세요.
예) “해당 문제는 1682851 커밋에서 해결되었습니다” - 혼란이나 토론이 커진다면, 깃허브기반의 텍스트 의사소통이 최선인지 스스로 반문해보세요. 대면(비대면) 으로 직접 얘기를 나누고, 서로 해당 사안에 대해 요약본을 작성하고 공유해주세요. (해당 사안에 대해 follow-up할 여러 사람에게 현재 혹은 이후에 큰 도움이 됩니다)
이 가이드라인은 Thoughtbot의 code review guide에
영감을 받아 작성되었습니다.
우리의 가이드라인은 우리의 업무방식과 우리가 육성하고 싶은 회사 문화에 맞게 작성되었습니다. 우리는 당신에게도 이 가이드라인이 도움이 되기를 바랍니다.
즐거운 의사소통되세요~
이상 미숙한 번역글이었습니다 ㅎㅎ
막상 번역해보니 스스로 pr로 소통을 할 때 조심하게 되는 부분이 있네요.
어떠한 방향이던
상황을 인지하고 불편해 하는 것은 성장의 시작이라고 생각합니다.
긴 글 읽어주셔서 감사합니다.
번역글의 원본은 글의 제일 상단에 위치해있습니다.
