Repository navigation
docs: 更新文案改成浅显写法 - #6
Merged
Merged
Conversation
改成「说人话、说影响」的写法: - 去掉每条开头的粗体小标题和冒号排比,一条一件事,一两句话说清 - 用户看不懂的实现细节(strptime 格式、age_days/stale、check.sh、py_compile) 要么删掉,要么换成「会出现什么现象」 - 修掉 v0.2.0 里一句不实的说明:「孤儿扫描的排除规则与同步一致」—— 当时同步只排目录、文件没排,这句话到 v0.2.1 才成立 - v0.2.0 段落与 Releases 页保持一致(只差标题层级)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
只改一个文件:
CHANGELOG.md。不动代码、不动配置、不影响部署。改了什么
原来的写法是每条一个粗体小标题、后面跟一长串分号从句,还夹着
strptime、age_days、stale、check.sh这种用户看不懂的实现细节。改成一条一件事、说清「会出现什么现象」,实现细节要么删要么换成白话。两处对照:
顺手修了一处不实表述
v0.2.0 的「说明」里写过「孤儿扫描的排除规则与同步一致」,当时并不成立——同步只排目录、文件没排(就是 v0.2.1 修的第二条)。这句从 v0.2.0 段落删掉,v0.2.1 里注明「从本版起才成立」。
与 Releases 页的关系
v0.2.0 段落与线上 Release 正文逐字一致(只差标题层级
##/###),因为 Releases 页的 v0.2.0 已经用同一份文案重写了。以后 v0.2.1 发版直接取这一段。验证
git diff --stat:1 file changed。没跑任何代码,也就不涉及 CI 的构建结果。