Repository navigation
[AI Generated][DOC] 换用 Keep a Changelog 与语义化版本导语 - #795
Merged
Merged
Conversation
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
1 participant
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.
无关联 issue。改动只落在 CHANGELOG.md 的导语，不动代码。
原来的导语是一段写给维护者的写作规则，读者打开文件先看到的是发布条目面向调用方、issue 引用置段尾括号、已发布条目是不可变历史，而这份文件本身如何组织、版本号按什么口径递增反而没有交代。现改为两句声明：本项目的所有重要变更都记录在此文件中，条目格式基于 Keep a Changelog，版本号遵循语义化版本，并给出两个规范站点的中文版链接。
取舍上，被替换的写作规则不另立新文体，其中条目形状与引用置段尾已在 CONTRIBUTING.md 的正文写作约定里有等价表述，保持单一事实来源；另两条（已发布条目保持写成时的语言、内部实现路径与决策沿革不进本文件）目前没有等价落点，本次一并删除，若判定仍需保留，宜迁入 CONTRIBUTING.md 的正文写作约定一节而不是回到导语。
有一点出入写在这里备查：本仓库 CHANGELOG 分节取 FEAT、FIX、CLEANUP、DEP、DOC、TEST，与 Keep a Changelog 的 Added、Changed、Removed 分类并不相同，因此导语用条目格式基于而不是遵循，只声明结构层面的对齐，不宣称分类一致。
验证：.venv/bin/python scripts/check_doc_quotes.py 通过，新增文本无直角引号；导语两个外链实测返回 HTTP 200。仓库内没有测试或门禁引用 CHANGELOG 头部，无其他文件需要同步。