Croot Blog

Home About Tech Hobby Archive

코드 리뷰

원칙

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

코드 리뷰 준비

준비사항

  • 브랜치 ID 규칙
  • PR 타이틀 규칙
  • PR Template 작성

메시지

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

Github PR 설명

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

코드 리뷰 수행

리뷰 방법

  • 리뷰가 중요한 코드의 경우 두 차례에 걸쳐 리뷰합니다.
    • 첫 번째 리뷰에서는 코드 변경 사항을 개략적으로 파악합니다.
    • 두 번째 리뷰에서는 세부 사항을 집중적으로 검토합니다.
💡
리뷰 코멘트 이모지 사용 예시
👍 : 칭찬 할 때 사용
❔ : 의도 혹은 로직이해가 안가는 등 질문 사항 (안중요한거라
❗ : 버그, 결함 등의 중요 수정사항 지적 시 사용
🙃 : 언짢음… 시비걸지마라…. 용 (?)