SuperAPI AI 工具集

shipping

写作与研究

查看项目

更新于 10-16 00:31

技能介绍

用途:在 FAST monorepo 中提交变更时,规范 PR 描述、变更文件与文档更新流程。

主要能力:按 .github/pull_request_template.md 生成 PR 描述(仅输出 markdown 代码块,去掉模板注释);PR 标题与合并提交使用约定式提交格式 <type>: <short summary>,常见类型 feat、fix、chore、docs、refactor、test、perf;为 packages/ 下的改动生成 Beachball 变更文件;更新 DESIGN.md、README.md 及最新版本文档。

使用方式:从 monorepo 根目录运行 npm run change 生成变更文件,跨分支时用 npm run change -- --branch origin/{branch-name}。变更前若修 bug 先写失败测试,运行 npm run build 与 npm run test;完成前确认 npm run build、npm run test、npm run format:check、npm run checkchange 均通过。修改导出 API 后运行 npm run prebuild -w sites/website 重新生成 API 文档。变更类型选 major(破坏性 API)、minor(新功能)、patch(修复)、none(不影响发布包)。变更注释写成发布说明式句子,首字母大写、句号结尾,不加 fix: 等前缀。

限制:不得自动执行 gh pr merge、gh pr close、npm publish、beachball publish 或修改分支保护与仓库设置。.github/、测试文件、package-lock.json、.vscode/、.prettierrc 的改动无需变更文件。破坏性变更需在 packages/<package>/docs/migration/ 下写迁移文档,重大变更建议先开讨论。多个不相关改动建议拆分为独立 PR。