Skip to content

docs: repoint CHK008/CHK018 to the surviving spec section#121

Merged
singyichen merged 1 commit into
mainfrom
docs/checklist-template-section-sync
Jul 21, 2026
Merged

docs: repoint CHK008/CHK018 to the surviving spec section#121
singyichen merged 1 commit into
mainfrom
docs/checklist-template-section-sync

Conversation

@singyichen

Copy link
Copy Markdown
Owner

Purpose

Fix the dangling section references in checklist-template CHK008 and CHK018 left behind by the What/How separation in PR #120.

Reason

spec-template v1.6.0 (PR #120) converted §輸入與生成規則 into a template-internal HTML comment, so spec instances no longer contain that section. CHK008 and CHK018 still anchored to it, which would send checklist authors to a section that does not exist. This could not ride along in PR #120 because a sixth file would exceed the 5-file PR limit (same split pattern as #118#119).

Result

Item Before After
CHK008 anchor Spec §輸入與生成規則 Spec §已釐清事項
CHK018 anchor Spec §輸入與生成規則 Spec §已釐清事項
Template version 1.9.0 1.9.1 (PATCH — reference fix, no semantic change)

§已釐清事項 is the surviving section that records clarify conclusions and intentional deviations, which is exactly what both items ask reviewers to verify.

Changed Files

File Change
.specify/templates/checklist-template.md CHK008/CHK018 section anchors updated; version bumped to 1.9.1 with changelog entry

Test Plan

  • grep "輸入與生成規則" .specify/templates/checklist-template.md returns no checklist-item references (only the changelog entry describing this fix)
  • §已釐清事項 exists in spec-template v1.6.0 as a landed section (verified at spec-template L32)
  • Version and changelog entry consistent (1.9.1, 2026-07-21)

Impact Scope

  • Frontend
  • Admin
  • API
  • Queue
  • Other: SDD governance (checklist template)

Related

Follow-up to #120

🤖 Generated with Claude Code

- **Replace** the dangling references to Spec section 輸入與生成規則 in CHK008 and CHK018, because spec-template v1.6.0 (PR #120) converted that section into a template-internal HTML comment that no longer appears in spec instances
- **Anchor** both items to Spec section 已釐清事項 instead, the surviving section that records clarify conclusions and intentional deviations
- **Ship** separately from PR #120 because adding a sixth file there would exceed the 5-file PR limit (same split pattern as PR #118#119)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@singyichen singyichen added the docs 文件需求/修正 — Documentation additions or fixes label Jul 21, 2026
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@amazon-q-developer amazon-q-developer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR correctly fixes the dangling section references left by PR #120. The changes update CHK008 and CHK018 to reference §已釐清事項 (the surviving section) instead of §輸入與生成規則 (which was converted to a template-internal HTML comment). The version bump to 1.9.1 and changelog entry are appropriate for a PATCH-level reference fix. No blocking issues identified.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the checklist template (.specify/templates/checklist-template.md) to version 1.9.1. Specifically, it updates the referenced sections for CHK008 and CHK018 from 'Spec §輸入與生成規則' to 'Spec §已釐清事項' to align with spec-template v1.6.0, and adds a corresponding entry to the changelog. There are no review comments, and I have no feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e90b784133

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


- [ ] CHK007 功能需求是否與每個使用者故事的驗收情境一致?[Consistency, Spec §功能需求]
- [ ] CHK008 原型、規格與需求來源的差異是否有記錄,而非靜默衝突?[Consistency, Spec §輸入與生成規則]
- [ ] CHK008 原型、規格與需求來源的差異是否有記錄,而非靜默衝突?[Consistency, Spec §已釐清事項]

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve checklist anchors for grandfathered specs

When /speckit.checklist is run against an existing feature spec, these references no longer resolve: all 16 current specs/**/spec.md files are explicitly grandfathered with ## 輸入與生成規則 and none has a ## 已釐清事項 heading (for example, specs/task-management/013-task-new/spec.md:12). The checklist command requires traceability references to existing spec sections, so CHK008 and CHK018 can now direct reviewers to a nonexistent heading for every existing spec. Use a backward-compatible reference or migrate the grandfathered specs before repointing the template.

Useful? React with 👍 / 👎.

@singyichen
singyichen merged commit 91a0443 into main Jul 21, 2026
10 checks passed
@singyichen
singyichen deleted the docs/checklist-template-section-sync branch July 21, 2026 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 文件需求/修正 — Documentation additions or fixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant