코드 리뷰 가이드
리뷰어 지정
- 모든 PR은 최소 1명 이상 리뷰 필수
- 담당 분야 외 코드도 가볍게 확인 권장
리뷰 포인트
필수 확인
- [ ] 코드가 의도대로 동작하는가?
- [ ] 버그나 예외 상황 처리가 되어있는가?
- [ ] 보안 이슈는 없는가? (API 키 노출 등)
권장 확인
- [ ] 코드 가독성은 괜찮은가?
- [ ] 중복 코드는 없는가?
- [ ] 테스트가 작성되어 있는가?
- [ ] 성능 문제는 없는가?
리뷰 코멘트 작성법
| 접두어 |
의미 |
예시 |
[필수] |
반드시 수정 필요 |
[필수] null 체크 필요합니다 |
[제안] |
개선 제안 (선택) |
[제안] 이 부분 함수로 분리하면 어떨까요? |
[질문] |
이해 안 되는 부분 |
[질문] 이 로직의 의도가 뭔가요? |
[칭찬] |
좋은 코드 |
[칭찬] 깔끔하네요! |
리뷰 받은 후
- 코멘트 확인 후 수정
- 수정 완료 시 "Resolve conversation" 클릭
- 모든 코멘트 해결 후 리뷰어에게 재요청