SuperAPI AI 工具集

fluid-pr-guide

写作与研究

查看项目

更新于 10-16 00:31

技能介绍

用途:在 Fluid Framework 中撰写、起草或审阅 PR 标题、描述与正文时使用,规范标题风格与正文结构。

标题风格:仅构建工具相关 PR 使用 Option A(Conventional Commits 前缀,如 fix: / fix(build-cli): / feat(devcontainer): 等,类型含 fix、feat、chore、build、docs,scope 为包或区域名);其他 PR 可用 Option B(纯祈使句或名词短语,无前缀)。两种风格不可混用,且禁止使用保留给机器人 PR 的 [bump] 前缀。

正文:始终包含 ## Description 段落,即使简短或与标题重复;聚焦原因与影响,修 bug 时给出复现步骤或演示修复的测试。从仓库根目录读取 .github/pull_request_template.md 作为起点,填写相关段落并删除不适用段落与占位文本,不留空段落。CI 要求删除前言占位行,否则 pr-validation.yml 检查失败。

其他段落:## Breaking Changes 仅在移除或改变公共 API 或行为、需要使用者迁移或构建调整时包含,并链接 wiki;## Reviewer Guidance 始终包含 wiki 链接行,有具体请求再补充内容,无则可删占位条目,未解决设计问题应标记为草稿。Azure DevOps 工作项可内联写为 AB#<item-id>,无需专门段落。

限制:资料未提供安装方式、命令、收费信息及更多模板细节,暂未提供。