变更日志模板

遵循 Keep a Changelog convention 的软件项目变更日志模板。

# Changelog Template：专业项目文档必备工具包 维护软件项目不仅仅是编写代码；它关乎如何向用户、贡献者和未来的自己传达工作的进展。然而，对于许多开发者来说，更新 CHANGELOG.md 文件往往被视为事后诸葛亮的工作，或者在忙于发布时被完全遗忘。“Changelog Template”是一款 Chrome 扩展程序，旨在填补这一空白，为维护符合行业标准规范的高质量变更日志提供精简、直观且专业的流程。 ## 核心目标：通过“Keep a Changelog”实现更好的沟通 Changelog Template 的核心在于帮助软件项目遵循“Keep a Changelog”规范。一份好的变更日志是为项目的每个版本精心整理、按时间顺序排列的重大变更列表。它不是原始 git 提交记录的堆砌，而是为人类撰写的文档。 通过使用此扩展，您可以确保项目的历史记录清晰、有序且实用。无论您是在管理小型副项目、大型开源库，还是内部工具套件，Changelog Template 都能为您提供保持透明度和专业性所需的结构，且不会增加开发周期的负担。 ## 您可以信赖的标准化格式 该扩展严格遵循标准的变更日志格式，确保您的文档看起来专业并与更广泛的生态系统保持兼容。您创建的每一项条目都会被归类为“Keep a Changelog”项目推荐的六种标准变更类型之一： 1. **Added（新增）：** 用于扩展软件功能的新特性。 2. **Changed（变更）：** 用于现有功能的变更，改变了功能的工作方式。 3. **Deprecated（弃用）：** 用于即将被移除的功能，提醒用户进行迁移。 4. **Removed（移除）：** 用于已正式从代码库中删除的功能。 5. **Fixed（修复）：** 用于解决问题并提高稳定性的任何错误修复。 6. **Security（安全）：** 用于修复漏洞的关键补丁。 这种分类有助于用户快速扫描您的发行说明，找到他们真正需要的内容，无论他们是在寻找新工具，还是在检查特定的错误是否已修复。 ## 撰写有影响力条目的指导 撰写优秀的变更日志条目是一门艺术。它需要在技术准确性和可读性之间取得平衡。Changelog Template 不仅仅提供一个文本框，它还提供了撰写关键条目所需的背景和指导。 我们倡导三条简单的规则： - **使用单句：** 保持简洁。每个条目描述一个明确的重点，远胜于一段冗长的文字。 - **使用过去式：** 您是在描述“已经发生了什么”（例如，使用“改进了搜索性能”而不是“改进搜索性能”）。 - **采用用户视角：** 为软件的使用者撰写，而不是为写代码的人撰写。不要说“重构了 SQL 查询优化器”，而要说“将搜索性能提高了 50%”。 该扩展甚至会提供辅助功能，自动将您的条目首字母大写，并在您忘记时确保它们以句号结尾。 ## 功能丰富的工作区 Changelog Template 包含了让文档编写感觉像是工作流中自然组成部分的各项功能： ### 1. 快速创建条目 “创建 (Create)”选项卡是您的主阵地。选择变更类型，输入条目，然后点击“添加到未发布 (Add to Unreleased)”。就是这么简单。无需再在 IDE 和 Markdown 文件之间切换，只为记下一次简单的更新。 ### 2. 持久化的“未发布”管理 优秀变更日志中最强大的功能之一是“未发布 (Unreleased)”部分。它作为您自上一个正式版本以来所做所有变更的暂存区。Changelog Template 为您管理此部分，将条目持久化存储在本地，以便您随时打开扩展程序时它们都准备就绪。 ### 3. 语义化版本控制 (SemVer) 参考 版本号不应该是猜谜游戏。我们的“参考 (Reference)”选项卡包含了语义化版本控制 (SemVer) 的快速入门指南，帮助您决定下一次发布应该是主版本号、次版本号还是修订号： - **MAJOR（主版本）：** 用于不兼容的 API 变更。 - **MINOR（次版本）：** 用于以向后兼容的方式增加功能。 - **PATCH（修订版本）：** 用于向后兼容的错误修复。 ### 4. 自动化工具参考 对于准备好进入下一步的团队，我们提供了通向行业标准自动化工具的指引，如 `standard-version`、`release-it` 和 `semantic-release`。这些工具与我们扩展生成的 Markdown 格式协同工作，可自动完成整个发布流程。 ### 5. 一键复制与 Markdown 导出 准备好更新文件后，您可以一键将“未发布”部分复制为格式化的 Markdown。需要开启新项目？使用我们的“完整 CHANGELOG.md 启动模板”来生成一个包含必要标题和链接的完整样板文件。 ## 为什么好的变更日志很重要 一份维护良好的变更日志不仅仅是更新列表；它是一个项目健康、成熟的标志。它通过向用户展示项目处于积极维护状态来建立**透明度**。它通过强调那些可能淹没在成百上千次提交信息中的重要变更，促进了**沟通**。最重要的是，它展示了**专业性**。当用户看到一份干净、有序的 CHANGELOG.md 时，他们知道他们可以信任这个项目及其背后的开发者。 ## 这适合谁？ - **独立开发者：** 让您的副项目保持井井有条，避免“我三个月前做了什么？”的困惑时刻。 - **小型团队：** 确保每个人对项目进度达成共识，无需为每次细微的更新维护复杂的 Jira 看板。 - **开源贡献者：** 通过提供清晰易读的发行说明，让您的项目对新用户更具吸引力。 ## 易于使用：无需设置，毫无烦恼 Changelog Template 设计为在您需要它之前处于不可见状态。无需复杂的设置，无需创建外部账户，也无需管理 API 密钥。它使用 Chrome 的本地存储来保护您的数据隐私，并确保只有在您的机器上才能访问。用户界面简洁且响应迅速，完美贴合浏览器的侧边栏或弹出区域。 别让您的项目文档落后。立即开始使用 **Changelog Template**，赋予您的软件应有的专业历史记录。