https://www.youtube.com/watch?v=ssDMIcPBqUE&list=WL
왜 코드 리뷰를 해야 하나?
설계에 투자하자
- 설계? 누구나 재생산 가능한 문서, 가이드
- SW 공학에서 설계 = code
클린 코드의 중요성
- SW 공학은 유지보수의 비용이 큰 편
- 많은 시간을 누군가의 코드를 이해하는 데 사용함
목적
- 품질 문제 검수(버그, 장애)
- 향후 변경 비용 개선
- 학습 및 지식 전달
코드 리뷰의 절차
- 저자 코드 작성, 리뷰 요청, 피드백 반영
- 리뷰어 검토, 피드백
- 1-2 반복
- 리뷰어 Merge 승인
- 저자 Merge
효율적인 PR 방법
1. 유의미한 Commit 구분
2. 궁금점 선리플
3. 테스트 방법 기술
효율적인 리뷰 방법
1. 코드 리뷰는 높은 우선 순위로 하자
- 저자는 리뷰 종료될 때까지 대기해야 하므로
- 1일 이내 처리, 최대 4시간 내
2. 고수준으로 시작, 저수준으로 내려가라
- 고수준 : 버그, 장애, 성능, 보안 이슈 등
- 저수준 : 주석 변경, 선택적인 개선 방향 등
3. 예제 코드 제공도 나쁘지 않다.
4. 리뷰의 범위를 존중하라
- PR 라인만 리뷰
5. 태그를 활용
- 이 리뷰는 고치면 좋은 정도다 하는 의미를 주는 태그 등을 붙이기
6. 한 두 등급의 코드 레벨만 올리는 것을 목표로 하라
- 기능적으로 틀렸거나, 너무 복잡해서 감당 안될 것 같은 코드 아니면 한 번에 다 뜯어 고치려 하지 말 것
7. 명령이 아닌 요청으로
기타 팁
- 스타일 가이드를 통해 스타일 논쟁이 주가 되지 않게 하기
- 혼자 개발해도 코드 리뷰 하자
