技能分享变更日志

其他 社区

技能解读

当前原文的自动摘译,尚未人工审校。

第 3 步:对变更进行分类

按常规提交类型对提交进行分组:前缀·类别feat· 新功能fix· 错误修复refactor· 重构

第 4 步:阅读现有条目以获取样式参考

在写作之前,请阅读以下最新的 2-3 条内容:CHANGELOG.md以匹配既定的语气和结构。风格随着时间的推移而演变——始终匹配最新的条目,而不是硬编码的模板。

第 5 步:编写面向用户的条目

从用户的角度来写。仅包含用户会注意到或关心的更改。包括: 新功能和使用示例(CLI 命令、代码块) 影响用户可见行为的错误修复 重大更改(重命名、删除标志、范围更改)

第6步:更新CHANGELOG.md

阅读现有的CHANGELOG.md并在标题后面的顶部插入新条目。与最新条目的风格完全匹配。结构约定(以实际条目为准):skillshare 命令 --flag # 用法示例 风格要点:版本号使用[X.Y.Z]没有v标题中的前缀

第 7 步:同步网站变更日志

该网站有自己的变更日志页面:website/src/pages/changelog.md。更新后CHANGELOG.md,将新条目同步到网站版本。两个文件之间的区别: 网站文件有 MDX frontmatter (title,description)和一个介绍段落 - 保留这些,不要覆盖网站文件有一个---简介之后、第一个版本条目之前的分隔符 发行条目本身的内容相同

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
通用
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@JetBrains · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 8 步:发布说明(仅限维护人员)

`specs/RELEASE_NOTES_<version>.md`仅当用户是项目维护者(runkids)时生成。贡献者跳过此步骤。检查是否以维护者身份运行: 如果是维护者: 阅读最新的`specs/RELEASE_NOTES_*.md`作为样式参考生成`specs/RELEASE_NOTES_<version>.md`(不`v`前缀,例如`RELEASE_NOTES_0.17.6.md`)

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。