SuperAPI AI 工具集

doris-pr-description

编程与开发

查看项目

更新于 11-04 13:58

技能介绍

doris-pr-description 是 Apache Doris 社区(apache/doris-skills)提供的拉取请求描述写作技能,面向向 apache/doris 的 master 分支提交 PR 的贡献者。其核心目的是帮助作者写出让评审者能快速判断的标题与描述。

用途与理念:评审者时间稀缺,PR 描述要在一分钟左右说明改动是否值得评审、先看什么、需要多少时间。这一分钟主要花在标题、Background、Problem Summary 以及 GitHub 展示的 diff 规模上,因此这些内容必须共同回答:PR 做什么、为何 diff 这么大、对现有用户有什么变化。评审者往往不熟悉 PR 涉及的模块或功能,所以描述开头用简短的 Background 提供上下文。AI 评审主要关注逻辑错误,很少评论为何需要此改动、为何选择此方案,而这些答案只有作者能提供,人工评审近半数评论也在追问这些,该标准正侧重于此。标准适用于针对 apache/doris master 的 PR;发布分支的 cherry-pick 保留原 PR 描述,不在范围内。

主要能力(模式):

  • Create:为当前分支创建 PR;若 Feature 缺少 issue 则一并创建,用户确认草稿后推送并创建。
  • Update:改进用户自己 PR 的标题或描述,确认后编辑。
  • Rewrite:重写任意 PR 的描述,用于比较或评估,不写入 GitHub,只写文件。
  • Check:判断现有描述是否符合标准,不写入 GitHub,只报告。 由于发布对整个社区可见,有疑问时应先起草并询问。

使用方式:技能目录内路径为相对路径,按当前步骤只读取所需参考文件,不提前读取;会话中已读文件除非上下文被压缩否则不重复读。工作流为:

  1. 收集事实。Create 和 Update 模式先按 references/handoff-intake.md 查找开发环节留下的 handoff 文件,有则以其中事实为来源、不重复收集;无 handoff 以及 Rewrite/Check 模式按 references/facts/basics.md 收集,改代码的 PR 加读 existing-tests.md,Bugfix 加读 bugfix-origin.md,diff 移动子模块指针时读 submodules.md。Rewrite 模式须先读 references/rewrite.md,如有冲突以其为准。收集量大时(大 diff、多个发布分支、长评审线程)按 references/subagents.md 决定交给子代理的内容。
  2. 分类 PR 类型:优先取 handoff 文件,否则按 references/classify.md 判断,然后读取对应类型文件 references/types/<file>.md,类型包括 bugfix、performance、feature、enhancement、refactor、test、build-ci-chore、revert、release-dependency、other。
  3. 若满足 references/stop-and-ask.md 中的条件则停止并询问。
  4. 按 references/write.md 撰写草稿,参照 references/examples/<file>.md 中该类型的示例;Feature 无 issue 时按 references/issue.md 起草 issue。
  5. 按 references/check-and-publish.md 运行检查器并修正其报告的问题。
  6. 展示草稿,仅在用户确认后按同一文件发布。 Check 模式执行第 1、2 步后,按 check-and-publish.md 中 Check 模式部分操作。

适用场景:为 Apache Doris 提交新 PR、改进自己 PR 的标题/描述、评估或重写他人 PR 描述、检查现有描述是否符合 Doris PR 标准。

限制:仅适用于 apache/doris master 的 PR,cherry-pick 不在范围;发布前必须获得用户确认;Rewrite 与 Check 模式不会修改 GitHub。具体检查规则、类型示例与发布步骤的细节以技能目录中的参考文件为准,资料未逐条展开。