mirror of
https://github.com/clash-verge-rev/clash-verge-rev.git
synced 2026-10-27 16:22:11 +08:00
The v2.5.4 notes had grown to 97 free-form entries exposed verbatim in the in-app update dialog. Distill them to 58 one-theme-per-line entries capped at ~60 CJK characters with no internal terminology, and move the writing rules into template/Changelog.md so every cycle starts from them. Release plumbing now agrees on the --- divider: extract_update_logs.sh stops there like updatelog.mjs, so file-only content never reaches release bodies, while updater.mjs appends a per-tag See More link to the update notes it generates. scripts-workflow/group_platforms.sh locks platform entries under emoji platform headings, wired into pre-commit, release and autobuild CI, and the changelog bump script; AGENTS.md points agents at the template rules.
38 lines
1.6 KiB
Markdown
38 lines
1.6 KiB
Markdown
<!-- Release-notes skeleton. Entries accumulate in ./Changelog.md as PRs land;
|
|
before publishing a release, distill them:
|
|
- user-visible changes only — no dev tooling, CI fixes, or refactors whose
|
|
effect is already covered by another entry
|
|
- describe outcomes, not internals: no internal module names, IPC or
|
|
protocol details, or implementation mechanics — write what the user
|
|
observes, not how the code achieves it
|
|
- one line per theme: merge entries that share a root cause
|
|
- each entry fits a single readable line (about 60 CJK characters); if it
|
|
overflows, it is packing multiple themes or detail that belongs in the
|
|
linked issue/PR — split it or drop the detail
|
|
- line grammar: open with a verb (修复/新增/优化), with the platform
|
|
first (Windows/macOS/Linux) when the change is platform-specific;
|
|
merge sub-symptoms as 主题:症状、症状; full-width punctuation,
|
|
「」 for UI labels, backticks for config keys and commands
|
|
- platform entries sit under their platform heading (bold, emoji
|
|
prefixed, ordered Windows/macOS/Linux, combined for pairs like
|
|
macOS/Linux) at the end of their section;
|
|
scripts-workflow/group_platforms.sh regroups, --check verifies
|
|
HTML comments are stripped by the update dialog's sanitizer and hidden on
|
|
GitHub, so they never reach users. -->
|
|
## v(Version Goes Here)
|
|
|
|
<details>
|
|
<summary><strong> 🐞 修复问题 </strong></summary>
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary><strong> ✨ 新增功能 </strong></summary>
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary><strong> 🚀 优化改进 </strong></summary>
|
|
|
|
</details>
|