mirror of https://github.com/garrytan/gstack.git
fix(document-release): move ## Important Rules to end of release-body section
The skill-llm-eval.test.ts judge test for 'document-release/SKILL.md workflow' slices from '# Document Release:' to '## Important Rules' in the combined SKILL.md + sections/release-body.md content. The marker was in SKILL.md (after Step 1.5), causing the judge to see only the stub (Steps 0-1.5) instead of the full 9-step workflow — resulting in scores of clarity=3, completeness=2, actionability=3 (all below the >=4/>=3/>=4 thresholds). Fix: move ## Important Rules from SKILL.md.tmpl to the end of release-body.md.tmpl (after Step 9 and CODEX_DOC_REVIEW). Regenerate. The judge now sees all 9 steps (~26K chars vs ~3K before) and should score at or above the required thresholds. Confirmed fix: runWorkflowJudge combines SKILL.md + sections/release-body.md, searches for '## Important Rules' in the combined string — which now appears at offset 69382 (after release-body content ends at Step 9).
This commit is contained in:
RagavRida
parent
66d66e290f
commit
c48972c0c8
|
|
@ -899,21 +899,3 @@ When significant gaps are found, suggest running `/document-generate` to fill th
|
|||
|
||||
> **STOP.** Before auditing each doc file and applying updates, polishing CHANGELOG voice, checking cross-doc consistency, cleaning up TODOS, the VERSION bump, and committing (Steps 2-9, after the coverage map in Step 1.5), Read `~/.claude/skills/gstack/document-release/sections/release-body.md` and execute it
|
||||
> in full. Do not work from memory — that section is the source of truth for this step.
|
||||
|
||||
---
|
||||
|
||||
## Important Rules
|
||||
|
||||
- **Read before editing.** Always read the full content of a file before modifying it.
|
||||
- **Never clobber CHANGELOG.** Polish wording only. Never delete, replace, or regenerate entries.
|
||||
- **Never bump VERSION silently.** Always ask. Even if already bumped, check whether it covers the full scope of changes.
|
||||
- **Be explicit about what changed.** Every edit gets a one-line summary.
|
||||
- **Generic heuristics, not project-specific.** The audit checks work on any repo.
|
||||
- **Discoverability matters.** Every doc file should be reachable from README or CLAUDE.md.
|
||||
- **Coverage map informs, never generates.** The Diataxis coverage map flags gaps for the PR body
|
||||
and future work. It does NOT auto-generate missing documentation pages or sections. When gaps
|
||||
are found, suggest `/document-generate` as the follow-up skill.
|
||||
- **Diagram drift is advisory.** Flag stale architecture diagrams in the PR body but do not
|
||||
auto-edit ASCII art or Mermaid blocks — they require human judgment to update correctly.
|
||||
- **Voice: friendly, user-forward, not obscure.** Write like you're explaining to a smart person
|
||||
who hasn't seen the code.
|
||||
|
|
|
|||
|
|
@ -140,21 +140,3 @@ When significant gaps are found, suggest running `/document-generate` to fill th
|
|||
---
|
||||
|
||||
{{SECTION:release-body}}
|
||||
|
||||
---
|
||||
|
||||
## Important Rules
|
||||
|
||||
- **Read before editing.** Always read the full content of a file before modifying it.
|
||||
- **Never clobber CHANGELOG.** Polish wording only. Never delete, replace, or regenerate entries.
|
||||
- **Never bump VERSION silently.** Always ask. Even if already bumped, check whether it covers the full scope of changes.
|
||||
- **Be explicit about what changed.** Every edit gets a one-line summary.
|
||||
- **Generic heuristics, not project-specific.** The audit checks work on any repo.
|
||||
- **Discoverability matters.** Every doc file should be reachable from README or CLAUDE.md.
|
||||
- **Coverage map informs, never generates.** The Diataxis coverage map flags gaps for the PR body
|
||||
and future work. It does NOT auto-generate missing documentation pages or sections. When gaps
|
||||
are found, suggest `/document-generate` as the follow-up skill.
|
||||
- **Diagram drift is advisory.** Flag stale architecture diagrams in the PR body but do not
|
||||
auto-edit ASCII art or Mermaid blocks — they require human judgment to update correctly.
|
||||
- **Voice: friendly, user-forward, not obscure.** Write like you're explaining to a smart person
|
||||
who hasn't seen the code.
|
||||
|
|
|
|||
|
|
@ -475,3 +475,21 @@ Substitute: STATUS = "clean" if no gaps, "issues_found" if gaps exist. SOURCE =
|
|||
**Cleanup:** Run `rm -f "$TMPERR_DOC"` after processing (if Codex was used).
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Important Rules
|
||||
|
||||
- **Read before editing.** Always read the full content of a file before modifying it.
|
||||
- **Never clobber CHANGELOG.** Polish wording only. Never delete, replace, or regenerate entries.
|
||||
- **Never bump VERSION silently.** Always ask. Even if already bumped, check whether it covers the full scope of changes.
|
||||
- **Be explicit about what changed.** Every edit gets a one-line summary.
|
||||
- **Generic heuristics, not project-specific.** The audit checks work on any repo.
|
||||
- **Discoverability matters.** Every doc file should be reachable from README or CLAUDE.md.
|
||||
- **Coverage map informs, never generates.** The Diataxis coverage map flags gaps for the PR body
|
||||
and future work. It does NOT auto-generate missing documentation pages or sections. When gaps
|
||||
are found, suggest `/document-generate` as the follow-up skill.
|
||||
- **Diagram drift is advisory.** Flag stale architecture diagrams in the PR body but do not
|
||||
auto-edit ASCII art or Mermaid blocks — they require human judgment to update correctly.
|
||||
- **Voice: friendly, user-forward, not obscure.** Write like you're explaining to a smart person
|
||||
who hasn't seen the code.
|
||||
|
|
|
|||
|
|
@ -360,3 +360,21 @@ If all coverage is complete and no diagrams drifted, output: "Coverage: all ship
|
|||
---
|
||||
|
||||
{{CODEX_DOC_REVIEW}}
|
||||
|
||||
---
|
||||
|
||||
## Important Rules
|
||||
|
||||
- **Read before editing.** Always read the full content of a file before modifying it.
|
||||
- **Never clobber CHANGELOG.** Polish wording only. Never delete, replace, or regenerate entries.
|
||||
- **Never bump VERSION silently.** Always ask. Even if already bumped, check whether it covers the full scope of changes.
|
||||
- **Be explicit about what changed.** Every edit gets a one-line summary.
|
||||
- **Generic heuristics, not project-specific.** The audit checks work on any repo.
|
||||
- **Discoverability matters.** Every doc file should be reachable from README or CLAUDE.md.
|
||||
- **Coverage map informs, never generates.** The Diataxis coverage map flags gaps for the PR body
|
||||
and future work. It does NOT auto-generate missing documentation pages or sections. When gaps
|
||||
are found, suggest `/document-generate` as the follow-up skill.
|
||||
- **Diagram drift is advisory.** Flag stale architecture diagrams in the PR body but do not
|
||||
auto-edit ASCII art or Mermaid blocks — they require human judgment to update correctly.
|
||||
- **Voice: friendly, user-forward, not obscure.** Write like you're explaining to a smart person
|
||||
who hasn't seen the code.
|
||||
|
|
|
|||
Loading…
Reference in New Issue