PR提交规范

3小时前更新 1 00
PR提交规范PR提交规范
PR提交规范

技能简介

该技能用于规范代码提交和Pull Request创建流程,要求人工编写PR意图说明并留存执行证据,使代码变更可被人类和智能体共同审阅。

能做什么

  • 强制执行高信息量的提交信息格式
  • 要求人工提供PR意图描述,禁止生成或改写
  • 区分纯提交任务与PR创建/更新任务的处理路径
  • 收集环境元数据作为PR历史记录

使用说明

  1. 安装依赖:需确保已安装 gh GitHub CLI 工具
  2. 配置仓库:检查是否存在 AGENTS.mddocs/agents/PROCESS.md 以获取仓库特定规则
  3. 纯提交场景:执行 references/workflow-commit.md 中的步骤,使用 references/commit-format.md 的格式
  4. PR场景:执行 references/workflow-pr.md 中的步骤,使用 references/pr-human-template.md 模板(须原样使用)
  5. PR草稿处理:使用 /tmp 目录存放PR正文草稿,通过 gh pr edit --body-file 更新
  6. 可选脚本:如存在 scripts/build_pr_body.sh,调用以收集环境元数据

输入与输出

见下方输入与输出表格。

项目内容
输入用户任务描述、人工编写的PR意图文本、仓库规则文件(AGENTS.md/PROCESS.md)、环境元数据
输出格式化提交信息、结构化PR正文、/tmp草稿文件、更新后的Pull Request
适用人群开发团队、技术负责人、开源维护者、需要规范代码提交流程的组织
不包含代码质量自动修复、CI/CD配置、合并冲突解决、分支策略制定

 

风险提示

  • 禁止自动生成或改写用户意图文本,必须由人工提供
  • PR模板必须原样使用,不得修改结构
  • 未读取仓库特定规则可能导致流程不符合团队要求
  • 缺少 gh CLI 将导致PR编辑命令失败

来源信息

原始链接:https://github.com/openclaw/skills/tree/main/skills/joshp123/pr-commit-workflow/SKILL.md
来源类型:开源技能文件

数据统计

相关导航

暂无评论

none
暂无评论...