코드 리뷰 문화와 PR 모범 사례

코드 리뷰는 진입을 막는 일이 아니라 팀이 함께 배우고, 책임을 나누며, 높은 품질을 유지하는 방법입니다. 좋은 리뷰 문화는 팀 전체를 성장시키지만, 나쁜 리뷰 문화는 병목과 불만을 만듭니다.

1) 가능하면 400줄 이하로 작게 유지합니다. 2) 명확한 설명을 작성합니다. 왜 필요한지, 무엇을 변경했는지, 어떻게 테스트하는지를 포함합니다. 3) 티켓을 연결합니다. 4) 사용자 인터페이스를 변경했다면 스크린샷이나 동영상을 추가합니다. 5) 리뷰어를 요청하기 전에 자신의 변경 내역을 직접 리뷰합니다.

커밋과 동일한 관례적 접두사를 사용합니다: feat: add user profile page, fix: handle 404 in fetch wrapper, refactor: extract Avatar component. 많은 팀이 이러한 접두사로 변경 로그를 생성합니다.

대부분의 팀은 PR 템플릿을 사용합니다. 저장소의 .github/pull_request_template.md에 설치합니다.

리뷰어를 요청하기 전에 자신의 변경 내역을 한 줄씩 검토합니다. 바로 이해하기 어려운 선택에는 그 이유를 설명하는 주석을 추가합니다. 다른 사람이 찾아야 하기 전에 자신의 오류를 직접 발견하는 경우가 많습니다.

2000줄짜리 PR은 철저한 리뷰를 받기 어렵습니다. 다음과 같이 나누십시오. 1) 동작 변경이 없는 리팩터링, 2) 새로운 동작, 3) 사용자 인터페이스 다듬기. 각각 리뷰하기도 쉽고 되돌리기도 쉽습니다.

명령이 아니라 질문의 형태로 표현합니다. '이 부분을 훅으로 추출하는 건 어떻게 생각하시나요?'가 '이것을 추출하세요'보다 좋습니다. 반드시 수정해야 하는 항목과 있으면 좋은 항목을 구분합니다. 다음과 같은 접두사를 사용합니다: nit:, question:, blocker:.

'이건 혼란스럽습니다'라고만 하면 작성자는 무엇을 해야 할지 알 수 없습니다. '조기 반환을 이해하려고 이 부분을 세 번 읽어야 했습니다. 가드 절로 추출할 수 있을까요?'라고 하면 작성자가 바로 행동으로 옮길 수 있습니다.

기발한 해결책, 좋은 이름 짓기, 유용한 테스트에는 긍정적인 의견을 남깁니다. 그러면 이러한 패턴을 장려할 수 있고 나머지 피드백도 더 부드럽게 전달됩니다. 비판만 받는 PR은 적대적으로 느껴집니다.

Prettier는 서식 지정을 처리하고 ESLint는 스타일을 처리합니다. 탭과 공백 중 무엇을 사용할지에 리뷰 시간을 낭비하지 마십시오. 특정 스타일 규칙이 계속 문제로 나온다면 린터에 규칙으로 추가합니다.

테스트도 코드입니다. 새 코드에 테스트가 있는지 확인합니다. 테스트가 실제로 올바른 부분을 실행하는지도 점검합니다. 잘못된 대상을 검증하기 때문에 코드가 망가져도 통과하는 테스트가 많습니다.

엄지손가락을 올린 이모지만 남기더라도 모든 의견에 응답합니다. 동의하지 않는 제안에는 반론을 제기하십시오. 코드를 작성한 사람은 본인이므로 더 많은 맥락을 알고 있을 수 있습니다. 해결된 대화는 해결됨으로 표시합니다. 범위가 바뀌면 PR 설명을 업데이트합니다.

영업일 기준 하루 안에 리뷰합니다. 오래된 PR은 맥락을 잃습니다. 작성자는 이미 다음 작업으로 넘어갔고 브랜치는 다시 기준에 맞춰야 합니다. 일주일 동안 방치된 큰 PR은 항상 끔찍하게 병합해야 하는 상태가 됩니다.

GitHub의 제안 기능을 사용하면 작성자가 한 번의 클릭으로 수정 사항을 적용할 수 있습니다. 설명문으로 '이 줄을 X로 바꾸세요'라고 쓰는 것보다 훨씬 빠릅니다.

다음 조건을 만족할 때 승인합니다. 코드가 올바르고, 테스트가 통과하며, 변경 사항을 이해하고 있고, 안전하게 병합할 수 있어야 합니다. 승인한다는 것은 결과에 공동으로 책임을 진다는 뜻입니다. 형식적으로 승인하지 마십시오. 읽지 않았다면 읽지 않았다고 말합니다.

작성자: 작고 설명이 잘 되어 있으며 스크린샷과 테스트가 포함된 PR을 만듭니다. 먼저 직접 리뷰합니다. 리뷰어: 건설적이고 질문 중심의 피드백을 제공합니다. 반드시 해결해야 하는 문제와 사소한 지적을 구분합니다. 좋은 점은 칭찬합니다. 스타일 문제는 도구가 처리하도록 맡깁니다. 하루 안에 리뷰합니다. 이해한 경우에만 승인합니다. PR 템플릿으로 과정을 표준화합니다. 리뷰는 진입을 막는 일이 아니라 협업입니다.