<aside> 💡 이 템플릿에 코드 리뷰 방법을 정리하세요. 특히 신입 직원과 원격 근무를 하는 직원에게 가이드라인을 제공하는 데 유용합니다.

</aside>

원칙

코드 리뷰를 하는 이유는 무엇이고 리뷰의 기본 원칙은 무엇인가요?

엔지니어링 가이드라인 템플릿처럼 관련된 다른 페이지를 멘션하는 것도 좋은 방법입니다. 페이지 내에 다른 페이지를 링크하려면 @ 다음에 페이지 이름을 입력하세요(예: Linux).

코드 리뷰 준비

리뷰가 필요한 코드를 준비하세요.

메시지

커밋 메시지에는 충분한 설명을 담아 주세요.

Github PR 설명

PR 설명도 매우 중요합니다. 이번 커밋의 변경 사항과, 어떻게 변경되었는지 적어주세요.

코드 리뷰 수행

리뷰 방법

• 리뷰가 중요한 코드의 경우 두 차례에 걸쳐 리뷰합니다.
  • 첫 번째 리뷰에서는 코드 변경 사항을 개략적으로 파악합니다.
  • 두 번째 리뷰에서는 세부 사항을 집중적으로 검토합니다.

예시

var commentCount = 0;

이 예시에서는 var이 아니라 let을 사용할 것을 제안합니다.