리뷰 의견의 강도를 분명히 표현하기, 경계 조건에서 다시 살펴보기
수정이 필수인 결함과 개인적인 취향이 같은 어조로 전달되면 작성자가 우선순위를 판단하기 어렵다. 의견의 이유와 강도를 함께 적어야 한다. 정상 경로 밖의 입력를 중심으로 작은 예제와 확인 기준을 정리합니다.
수정이 필수인 결함과 개인적인 취향이 같은 어조로 전달되면 작성자가 우선순위를 판단하기 어렵다. 의견의 이유와 강도를 함께 적어야 한다.
대표 예제 하나가 통과해도 기능의 경계가 명확해진 것은 아니다. 값이 없거나 예상보다 많을 때, 실행이 늦어지거나 순서가 바뀔 때 다른 규칙이 숨어 있을 수 있다. 이번 기록에서는 정상 경로를 유지한 채 입력 범위를 넓혀 보고 무엇을 허용할지 구분한다.
정상 경로 밖의 입력
정확성 문제, 유지보수 제안, 확인 질문, 선택적 취향을 구분한다. 필수 변경에는 실패 조건이나 계약을 근거로 제시하고 대안을 열어 둔다.
이번에 확인할 질문: 예상 범위를 벗어난 입력은 조용히 다른 결과를 만들지 않고 구분되는가?
작게 확인하는 예제
다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.
Required: this path can commit only half of the operation.
Question: should an empty value be accepted here?
Suggestion: naming the intermediate result may clarify the rule.
Optional: the current ordering is also acceptable.
작성자가 어떤 의견을 반드시 해결해야 하는지와 그 이유를 리뷰 기록에서 바로 찾을 수 있는지 확인한다.
놓치기 쉬운 조건
라벨을 붙였다고 공격적인 표현이나 근거 없는 단정이 해결되지는 않는다. 코드의 효과를 논의하고 작성자의 능력이나 의도를 추측하지 않는다.
| 확인할 부분 | 살펴볼 내용 |
|---|---|
| 기준 동작 | 작성자가 어떤 의견을 반드시 해결해야 하는지와 그 이유를 리뷰 기록에서 바로 찾을 수 있는지 확인한다. |
| 비교 조건 | 입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다. |
| 적용 범위 | 예제가 생략한 의존성과 실제 서비스의 제약을 구분한다. |
다음 변경에 적용할 순서
- 빈 값과 최소 크기부터 확인 범위를 넓힌다.
- 한 번에 여러 경계를 섞지 않고 각각의 결과를 기록한다.
- 지원하지 않는 조건은 허용 범위와 함께 분명하게 설명한다.
모든 입력을 성공시켜야 좋은 인터페이스가 되는 것은 아니다. 지원 범위를 예측할 수 있고 실패 이유가 분명한 편이 더 다루기 쉽다. 경계 조건을 문서와 예제에 함께 남겨야 다음 구현에서도 같은 기준을 적용할 수 있다.
이 이야기가 도움이 되었나요?