콘텐츠로 이동

CHK-001 미완료 항목

Markdown의 체크리스트(- [ ] / - [x])가 모두 체크되어 있는지를 검증합니다. 미체크된 항목이 남아 있으면 warning 으로 보고됩니다.

릴리스 전 리뷰 체크리스트나 마이그레이션 작업의 작업 리스트 등 「모든 것이 채워져 있는 것이 완료의 조건」 이 되는 체크리스트가 많이 있습니다. 그러나 - [ ] 인 채로 머지해도 Markdown으로서는 valid이기 때문에, 리뷰에서도 CI에서도 통과해 버립니다. 완료 상태를 기계적으로 검출함으로써 리뷰 전의 누락을 방지할 수 있습니다.

필드타입필수설명
sectionstring검증 대상을 특정 섹션 하위의 체크리스트로 한정(제목 텍스트의 완전 일치)
filesstring이 규칙을 적용할 파일의 glob

옵션 전체를 생략해도 동작합니다(모든 섹션의 체크리스트가 대상).

## Review Checklist
- [x] Code review completed
- [ ] Security review completed
- [x] Tests passing

Security review completed이 미체크이므로 위반이 됩니다.

docs/review.md
line 4 warning Unchecked item "Security review completed" in section "Review Checklist" CHK-001
## Review Checklist
- [x] Code review completed
- [x] Security review completed
- [x] Tests passing
{
"rule": "chk001",
"options": {
"section": "Review Checklist",
"files": "**/review.md"
}
}

section을 지정하면, 그 제목 하위의 체크리스트만 검증 대상으로 할 수 있습니다. 같은 파일에 리뷰용과 메모용 체크리스트가 혼재해 있어도, 리뷰용만 필수로 할 수 있습니다.