반응형
Q
코드리뷰 단계중 준비에 필요한 내용을 마크다운 문법으로 1000자내외로 적어줘
A
코드 리뷰 준비 단계
목표
코드 리뷰 준비 단계는 개발자가 자신의 코드를 다른 팀원에게 효과적으로 전달하고, 리뷰자가 이해하기 쉽게 코드를 읽을 수 있도록 하는 과정입니다.
준비 항목
- 문서화된 요구사항: 개발이 진행되기 이전에 작성된 요구사항 문서를 제공합니다.
- 코드 스냅샷/.diff 파일: 리뷰하고자 하는 코드의 변경 내용을 보여주는 스냅샷이나 .diff 파일입니다.
- 변경 로그 (Change Log): 최근 수정된 코드에 대한 변경 사항, 주석 등을 포함한 로그를 작성합니다.
- 테스트 케이스: 리뷰에 동반되는 테스트 케이스를 포함합니다.
- 결과 예시: 리뷰할 코드의 동작 결과를 미리 만들어 놓습니다.
- 아키텍처 스키마: 시스템 전체의 아키텍처나 해당 코드가 속한 모듈에 대한 스키마도 함께 제공합니다.
- 코드 리뷰 규칙 및 기준: 팀 내부에서 사용하는 코드 리뷰의 규칙과 기준을 문서로 제공합니다.
- 타임라인 및 마감일: 리뷰가 예정된 시간대와 마감일을 명시합니다.
- 비서류한 질문: 미리 팀원들에게 물어볼 수 있는 질문 목록을 작성합니다.
요약
코드 리뷰 준비 단계는 팀의 효율성을 높이기 위한 중요한 과정입니다. 필요한 문서와 정보를 체계적으로 준비하면, 리뷰 과정에서 시간과 에너지를 절약할 수 있습니다.
반응형