From f3c4cd7953f23ad395e893ecc9512ed4d0364dc0 Mon Sep 17 00:00:00 2001 From: qiyinxi Date: Sun, 15 Nov 2026 15:38:24 +0100 Subject: [PATCH] =?UTF-8?q?=E5=8A=A0=20changelog.d=EF=BC=9A=E7=94=A8?= =?UTF-8?q?=E6=88=B7=E7=9C=8B=E5=BE=97=E8=A7=81=E7=9A=84=E6=94=B9=E5=8A=A8?= =?UTF-8?q?=E5=9C=A8=20PR=20=E9=87=8C=E5=B8=A6=E4=B8=80=E8=A1=8C=E6=9B=B4?= =?UTF-8?q?=E6=96=B0=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Refs ModAVD/ModAVD#216 --- changelog.d/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 changelog.d/README.md diff --git a/changelog.d/README.md b/changelog.d/README.md new file mode 100644 index 0000000..f58ac25 --- /dev/null +++ b/changelog.d/README.md @@ -0,0 +1,23 @@ +# 更新说明 / Release note lines + +用户看得见的改动,在同一个 PR 里往这个文件夹加一个文件,写一行给用户看的话。ModAVD 发版时,工具把这个仓库上一版以后新加的文件汇总进 ModAVD 发版公告的「更新内容」,并在行尾补上这个 PR 的编号。不加文件的 PR 不会出现在公告里。 + +- **文件名**:`<名字>.<类型>.md`。名字用小写字母、数字、`-`、`_`,起一个不会和别的改动重复的(比如 issue 号加几个词:`210-resize-crash.fix.md`)。 +- **类型**:`feat` 新增,`fix` 修复,`change` 变更,`remove` 移除。 +- **内容**:只有一行,不超过 60 字,不能有 `--`。写用户会看到的结果,不写原因和实现,比如「调高分辨率后开机不再卡死退出」。 +- 想让公告指向 issue 而不是 PR,就自己在行尾写上,issue 都在 ModAVD 仓库,要写全称:`……不再卡死退出 (ModAVD/ModAVD#210)`;这样工具不再补 PR 编号。 +- 只和开发、测试、CI、文档有关的 PR 不用加。 +- 已经发过版的文件不要改内容、也不要重复用它的名字;以后的改动另起一个文件。 + +汇总的工具和完整的说明在 ModAVD 仓库:[changelog.d/README.md](https://github.com/ModAVD/ModAVD/blob/main/changelog.d/README.md)、[tools/pubrel/README.md](https://github.com/ModAVD/ModAVD/blob/main/tools/pubrel/README.md)。 + +--- + +A change that users can see adds one file here, in the same pull request, with a single line written for users. When ModAVD is released, its tools collect the files this repository gained since the previous release into the ModAVD release notes and append the pull request number. A pull request without a file is not announced. + +- **Name**: `..md`, the name in lowercase letters, digits, `-`, `_`, and unique (for example the issue number and a few words: `210-resize-crash.fix.md`). +- **Type**: `feat` (新增), `fix` (修复), `change` (变更), `remove` (移除). +- **Content**: one line in Chinese, at most 60 characters, without `--`. Say what users will notice, not the cause or the implementation. +- To point at an issue instead of the pull request, end the line with it yourself, in full: `…… (ModAVD/ModAVD#210)`. +- Pull requests that only touch development, tests, CI or documentation need no file. +- Do not edit or reuse a file that has already been released; a later change takes a new file.