Skip to content

Code Review Convention

part3-5 edited this page Dec 13, 2024 · 20 revisions

코드 리뷰 컨벤션

리뷰어 가이드라인

  1. 리뷰 타이밍

    • PR 생성 후 6시간 이내 첫 리뷰 완료
    • 수정 요청 후 재리뷰는 12시간 이내
            
  2. 리뷰 형식

    • 긍정적인 피드백 1개 필수
    • 필수 수정사항은 [Required] 태그 사용
    • 선택적 제안사항은 [Suggestion] 태그 사용
    • 질문은 [Question] 태그 사용
            
  3. 리뷰 중점 사항

    • 코드 컨벤션 준수 여부
    • 컴포넌트 구조의 적절성
    • 성능 최적화 가능성
    • 재사용성과 유지보수성
    • 타입 정의의 정확성
            
  4. 리뷰 피드백 대응

    • **[Required]** 태그 피드백은 반드시 수정
    • 수정 완료 시 해당 피드백에 ☑️ 이모지로 응답(색 상관없습니다. 체크이모지이면 OK)       
  5. PR 병합 조건

    • 최소 2명 이상의 승인 필요
    • 모든 [Required] 피드백 해결

Clone this wiki locally