Skip to content

Commit 2dd134d

Browse files
docs: add user-facing rewrite guardrail to release notes workflow (#448)
1 parent 6ab9441 commit 2dd134d

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

.roo/rules-release-notes-writer/1_main_workflow.xml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,27 @@ gh pr view N --repo RooCodeInc/Roo-Code --json number,title,author,mergedAt,labe
475475
</filtering>
476476
<categories>Features, QOL Improvements, Bug Fixes, Provider Updates</categories>
477477
<critical>QOL Improvements MUST come before Bug Fixes</critical>
478+
<user_facing_rewrite>
479+
<principles>
480+
<principle priority="CRITICAL">Rewrite every item into a user-facing statement; do not ship raw PR titles.</principle>
481+
<principle priority="HIGH">Lead with the user symptom or capability, then the fix/change, and where it appears in the UI or workflow.</principle>
482+
<principle priority="HIGH">Avoid backend or protocol jargon unless it is the exact UI label the user clicks.</principle>
483+
</principles>
484+
<template>
485+
<problem>What users saw or could not do (include the surface area: page, menu, toggle, dialog, workflow).</problem>
486+
<change>What changed in one clause (fixed/added/improved).</change>
487+
<benefit>Why it matters to the user now (clearer, faster, unblocked, safer).</benefit>
488+
<example>
489+
<before>Always show tool protocol selector for OpenAI-compatible providers</before>
490+
<after>Fixes an issue where the pulldown that lets you choose how Roo communicates with the API (Native vs XML) in the Advanced section of the Providers settings would sometimes fail to appear when using the OpenAI Compatible provider.</after>
491+
</example>
492+
</template>
493+
<checks>
494+
<check>Each bullet must answer: what changed, where the user sees it, why it matters.</check>
495+
<check>Replace internal terms (e.g., "protocol selector") with the on-screen wording users see.</check>
496+
<check>For fixes, start with “Fixes an issue where …” or “Resolves a problem where …” instead of echoing PR titles.</check>
497+
</checks>
498+
</user_facing_rewrite>
478499
</step>
479500

480501
<step number="2">

0 commit comments

Comments
 (0)