mirror of
https://github.com/garrytan/gstack.git
synced 2026-11-12 19:44:48 +01:00
document-release: changelog sell test as three questions, not a 0-3 score (s10 M6)
The threshold stays (fewer than two answered = needs attention, not replacement). M4/M5 (NEVER CLOBBER / NEVER BUMP) keep their wording; the integrator owns the eval-gated rewrite. W7a pin: workflow-excerpt:170 'Entries scoring <2 need attention, not replacement' becomes a case-insensitive check that weak entries get attention, not replacement. Template-only commit: generated SKILL.md is expected red until the regeneration commit.
This commit is contained in:
1 parent
c57a769a79
commit
ffd5ece2f2
2 files changed
+6
-6
No files matched your search
@@ -101,11 +101,11 @@ preserved them. This skill must NEVER do that.
|
||||
|
||||
**If CHANGELOG was modified in this branch**, review the entry for voice:
|
||||
|
||||
- **Sell test (Diataxis rubric):** Score each CHANGELOG entry 0-3:
|
||||
- **1 point** — answers "What changed?" (reference: names the feature/fix)
|
||||
- **1 point** — answers "Why should I care?" (explanation: user impact, pain removed)
|
||||
- **1 point** — answers "How do I use it?" (how-to: command, flag, or link to docs)
|
||||
- Entries scoring <2 need attention, not replacement. Report missing facts or user impact; polish existing wording only. A score of 3 passes all three checks.
|
||||
- **Sell test (Diataxis):** a good entry answers "What changed?" (names the
|
||||
feature/fix), "Why should I care?" (user impact, pain removed) and "How do I use
|
||||
it?" (command, flag, or link to docs). An entry that answers fewer than two of these needs
|
||||
attention, not replacement: report the missing facts or user impact, and polish
|
||||
existing wording only.
|
||||
- Lead with what the user can now **do** — not implementation details.
|
||||
- "You can now..." not "Refactored the..."
|
||||
- Flag commit-message-style entries and polish wording without removing facts.
|
||||
|
||||
@@ -167,7 +167,7 @@ describe('workflow judge excerpts', () => {
|
||||
expect(review).toContain('present the findings, then use AskUserQuestion ONCE:');
|
||||
expect(review).toContain('On A or per-finding approvals, make the approved edits yourself');
|
||||
expect(text).toContain('Step 9 then commits and pushes those edits');
|
||||
expect(text).toContain('Entries scoring <2 need attention, not replacement');
|
||||
expect(text).toMatch(/needs?\s+attention,?\s+not\s+replacement/i);
|
||||
expect(text).not.toContain('Flag and rewrite');
|
||||
expect(text).toContain('if VERSION is absent, use the completion date only');
|
||||
});
|
||||
|
||||
Reference in new issue
Block a user