mirror of
https://github.com/github/spec-kit.git
synced 2026-08-15 14:02:04 +02:00
bd04776dcc
* docs: clarify custom checklist lifecycle * docs: clarify implement checklist marker ownership --------- Co-authored-by: root <kinsonnee@gmail.com>
46 lines
2.0 KiB
Markdown
46 lines
2.0 KiB
Markdown
# [CHECKLIST TYPE] Checklist: [FEATURE NAME]
|
|
|
|
**Purpose**: [Brief description of what this checklist covers]
|
|
**Created**: [DATE]
|
|
**Feature**: [Link to spec.md or relevant documentation]
|
|
|
|
**Note**: This custom checklist is generated by the `__SPECKIT_COMMAND_CHECKLIST__` command based on feature context and requirements.
|
|
**Review Ownership**: This checklist is a reviewer-owned requirements-quality review artifact. Mark an item `[x]` only when the reviewer determines the requirements-quality criterion is satisfied.
|
|
**Marker Semantics**: `[x]` means the criterion has been reviewed and satisfied for requirements quality. It does not mean implementation work is complete.
|
|
|
|
<!--
|
|
============================================================================
|
|
IMPORTANT: The checklist items below are SAMPLE ITEMS for illustration only.
|
|
|
|
The __SPECKIT_COMMAND_CHECKLIST__ command MUST replace these with actual items based on:
|
|
- User's specific checklist request
|
|
- Feature requirements from spec.md
|
|
- Technical context from plan.md
|
|
- Implementation details from tasks.md
|
|
|
|
DO NOT keep these sample items in the generated checklist file.
|
|
============================================================================
|
|
-->
|
|
|
|
## [Category 1]
|
|
|
|
- [ ] CHK001 First checklist item with clear action
|
|
- [ ] CHK002 Second checklist item
|
|
- [ ] CHK003 Third checklist item
|
|
|
|
## [Category 2]
|
|
|
|
- [ ] CHK004 Another category item
|
|
- [ ] CHK005 Item with specific criteria
|
|
- [ ] CHK006 Final item in this category
|
|
|
|
## Notes
|
|
|
|
- Mark items `[x]` only after review confirms the requirement-quality criterion is satisfied
|
|
- Leave items unchecked when they still require clarification, correction, or reviewer evaluation
|
|
- `__SPECKIT_COMMAND_IMPLEMENT__` reads checklist checkbox state as a gate and must not modify markers
|
|
- `checklists/requirements.md` has a separate built-in lifecycle maintained by `__SPECKIT_COMMAND_SPECIFY__` and `__SPECKIT_COMMAND_CLARIFY__`
|
|
- Add comments or findings inline
|
|
- Link to relevant resources or documentation
|
|
- Items are numbered sequentially for easy reference
|