SuperAPI AI 工具集

changelog

通用与其它

查看项目

更新于 10-16 03:13

技能介绍

用途:为 react-native-true-sheet 的每个面向用户的 PR 在 CHANGELOG.md 的 ## Unreleased 中记录一次变更,通常在 gh pr create 之后、在 PR 分支上添加,以便随 squash merge 一起合入。scripts/release.sh 仅在稳定版发布时把 Unreleased 转为版本标题,beta 版跳过。

主要能力:判断条目应新增、扩展还是跳过;选择分区(🎉 New features、🐛 Bug fixes、💥 Breaking changes、💡 Others)与平台前缀(iOS、Android、Web,跨平台不加前缀);按规范撰写条目并提交。

判断规则:已发布指进入最新稳定版(git describe --tags --abbrev=0 --exclude '-' origin/v3,如 v3.11.18);main 是未发布的 v4,其 beta 不算已发布。对未发布条目的后续修复、同一变更的第二个 PR、同一技能或指南的更新应扩展现有条目并追加 PR 链接。从未发布的 bug 修复、仅存在于 Unreleased 的代码、来自 Unreleased PR 的回归(含已进入 beta 的)应跳过,除非改变条目描述或属于该 PR 的功能。文档小注、CI、测试、仅示例的构建修复也跳过。

撰写要求:每个 PR 一条,放在其主要分区下;平台限定条目加 iOS:、Android:、Web: 前缀,组内按 iOS → Android → Web → 无前缀排序,新条目加在组末。用一两句描述用户可见的变化,不写实现细节;bug 修复写“X no longer Y”而非“Fixed a bug where”;功能说明新增内容与用途;破坏性变更说明改了什么及如何应对;属性、事件、方法、值用反引号。署名包含 PR 作者及有实际贡献的提交共同作者,被取代的 PR 也署名其作者,@lodev09 放最后。

提交方式:在 PR 分支执行 git add CHANGELOG.md、git commit -m "docs: add changelog entry for #<n>"(扩展时用 update)、git push,并在 PR 正文勾选“I added a changelog entry (if needed)”。跳过的条目无需提交,需说明原因。

限制:资料未提供该技能在其他项目中的通用性、安装方式或额外工具依赖。