Skip to content

Commit ef8f9ce

Browse files
authored
docs(readme): lead with the current release and hand history to the changelog (#635)
docs(readme): lead with the current release and hand history to the changelog
2 parents 7e49452 + 03d3a26 commit ef8f9ce

9 files changed

Lines changed: 129 additions & 64 deletions

File tree

‎.github/workflows/release-prep.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ jobs:
129129
echo
130130
echo "- [ ] dsh-mneme/CHANGELOG.md 新节里的条目(现在只有一条「- (待填)」)"
131131
echo "- [ ] 两个 README 里新占位行的主题描述"
132-
echo "- [ ] 根 README 的「📰 最近更新」/「📰 Recent updates」表各加一行头条"
132+
echo "- [ ] 根 README 的「📰 最近更新」/「📰 Recent updates」段落的头条(现在是标题式散文,不是表格)"
133133
echo "- [ ] 跨 minor 时确认 README 路线图上新 minor 行的主题(占位行只写了「(待填)」)"
134134
echo "- [ ] 跨 minor 时把 SECURITY.md 中英两张支持版本表挪一格(活跃开发 / 尽力维护 / 不支持三段一起挪,含停止维护那段通知)"
135135
} > commit-msg.txt
@@ -146,7 +146,7 @@ jobs:
146146
echo
147147
echo "- [ ] CHANGELOG 新节的条目(dsh-mneme/CHANGELOG.md,现在只有一条「- (待填)」)"
148148
echo "- [ ] 两个 README 里新占位行的主题描述"
149-
echo "- [ ] 根 README 的「📰 最近更新」与「📰 Recent updates」表各加一行头条"
149+
echo "- [ ] 根 README 的「📰 最近更新」与「📰 Recent updates」段落的头条(现在是标题式散文,不是表格)"
150150
echo "- [ ] 跨 minor 时确认路线图新 minor 行的主题(占位行只写了「(待填)」)"
151151
echo "- [ ] 跨 minor 时把 SECURITY.md 中英两张支持版本表挪一格(活跃开发 / 尽力维护 / 不支持三段一起挪,含停止维护那段通知)——不挪的话,本 PR 的 CI 会在 security-doc.test.js 上红"
152152
echo

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Versioning follows semantic versioning (`MAJOR.MINOR.PATCH`). The mechanical par
154154
2. **Fill in what only a human can write**, in that PR:
155155
- the wording and the cuts in the CHANGELOG entries (`[Unreleased]` entries are already moved into the new section by the workflow — do not move them by hand; split them into subsections and rewrite them for outside readers). End the section with a `### 贡献者 / Thanks` subsection summarising outside contributors (`git log vPrev..HEAD --format='%an <%ae>' | sort -u`; list non-maintainers as "GitHub handle + what they did", and keep the inline 「感谢 @handle」 in the entry too); omit it when there are none. **Keep entries neutral**: no references to non-public issue numbers and no internal experiment codenames — nobody reading this repository can resolve them.
156156
- the theme text of the new placeholder rows in both READMEs;
157-
- one new row in each of the root README's 「📰 最近更新」 / 「📰 Recent updates」 tables (pure editorial content — the workflow never touches them).
157+
- the headline paragraph under the root README's 「📰 最近更新」 / 「📰 Recent updates」 heading (it is prose now, not a table — pure editorial content, the workflow never touches it).
158158
3. **Cross-minor releases only**: the workflow prints a warning instead of failing when `SECURITY.md`'s supported-versions table still names the previous minor. Shift both language tables down one row (new minor → active, previous minor → best-effort, and update the end-of-life notice below them) inside the same PR; until then `test/security-doc.test.js` is red, which is exactly when it should be.
159159
4. **Full test pass**: `npm test` must be green (`node scripts/check-sync.js` too, after any `lib/` change).
160160
5. **Merge the PR**, then tag: `git tag vX.Y.Z` → `git push origin vX.Y.Z`. Publishing from here on is automatic.
@@ -358,7 +358,7 @@ DSH 上游仍处于 developer preview 阶段,API 与服务接口变动频繁
358358
2. **在这个 PR 里补上只有人能写的内容**:
359359
- CHANGELOG 条目的措辞与取舍(`[Unreleased]` 攒的条目工作流已整段搬进新版本节,**不用手搬**;把它们分节并改写成外部读者能看懂的话)。小节末尾加 `### 贡献者 / Thanks` 汇总本版外部贡献者(`git log v上一版..HEAD --format='%an <%ae>' | sort -u`,非维护者逐条列「GitHub 用户名 + 一句话做了什么」,条目内也保留「感谢 @用户名」);无外部贡献者时省掉该小节。**条目一律用中性措辞**:不引用非公开的 issue 编号、不出现内部实验代号——它们在公开仓库里解析不出来,读者只会困惑。
360360
- 两个 README 里新占位行的主题描述;
361-
- 根 README 的「📰 最近更新」与「📰 Recent updates」表各加一行头条(纯编辑内容,工作流从不改写这两张表)。
361+
- 根 README 的「📰 最近更新」与「📰 Recent updates」那一段的头条(现在是标题式散文、不是表格;纯编辑内容,工作流从不改它)。
362362
3. **只有跨 minor 发版时**:`SECURITY.md` 的支持版本表还写着上一个 minor 时,工作流只警告不失败。在同一份 PR 里把中英两张表向下挪一格(新 minor 进活跃行、上一版进尽力维护行,并同步改下面的停止维护通知);在那之前 `test/security-doc.test.js` 是红的——那正是它该红的时候。
363363
4. **全量测试**:`npm test` 确认通过(动过 `lib/` 的话 `node scripts/check-sync.js` 也要过)。
364364
5. **合并 PR**,然后打 tag:`git tag vX.Y.Z` → `git push origin vX.Y.Z`。到此为止,发布是自动的。

0 commit comments

Comments
 (0)