<aside> 💡 Notion Tip: 이 템플릿에 코드 리뷰 방법을 정리하세요. 특히 신규 엔지니어와 원격 근무 중인 엔지니어에게 유용한 가이드라인이 되어줄 수 있습니다.

</aside>

철학

왜 코드 리뷰를 수행하나요? 리뷰의 기본 원칙은 무엇인가요?

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

코드 리뷰 준비

원활한 리뷰를 위해 대상 코드를 준비합니다.

메시지

Commit 메시지는 자세한 설명을 포함해야 합니다.

Github PR 설명

PR 설명은 Commit 메시지의 연장입니다. Commit의 변경 사항과 구현 방법에 대해 서술하세요.

코드 리뷰 수행

리뷰 방법

• PR이 중요한 역할을 하는 경우 두 차례의 리뷰를 수행합니다.
  • 첫 번째 리뷰에서는 코드 변경 사항을 개략적으로 파악합니다.
  • 두 번째 리뷰에서는 구문들의 세부 사항을 꼼꼼히 검토합니다.

예시

var commentCount = 0;

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