Skip to content

Commit 94b4eb6

Browse files
lostindarkCopilot
andcommitted
fix: enforce strict word limit for highlight descriptions
Max 10-15 words per item. No multi-sentence explanations. Skip summary paragraph for small releases. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 2128160 commit 94b4eb6

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

.github/workflows/release-highlights.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,14 @@ Structure:
7474
```
7575

7676
**Writing Guidelines:**
77-
- Keep descriptions short and concise — one sentence per item
78-
- Be specific about what changed, but don't over-explain
77+
- **MAXIMUM 10-15 words per item description** — e.g. "In-place self-update with SHA256 verification and automatic rollback."
78+
- Do NOT write multiple sentences per item. One short phrase only.
79+
- Do NOT explain how features work or provide implementation details
80+
- **Stay faithful to commit messages** — do not embellish, infer, or add details not in the commit message. If the commit says "fix X", describe it as fixing X, not what you think it might do.
7981
- For each item, include the PR number and the **actual PR author** (check the PR data, not the commit author — they may differ)
8082
- If a change has multiple PRs, list all PR numbers: `(#42 #43 by @author)`
8183
- End with a Full Changelog link comparing the previous published release tag to `${{ inputs.version }}`
82-
- This is a Windows desktop application — write from the end-user perspective
84+
- Skip the summary paragraph if there are fewer than 5 user-facing changes
8385

8486
### 4. Handle Special Cases
8587

0 commit comments

Comments
 (0)