用途
create-pr 是一个用于创建拉取请求(Pull Request)的技能,核心目标是在提交代码变更前,确保英文与中文文档保持同步。它适用于需要维护双语文档(尤其是技能目录)的仓库,帮助开发者在提交 PR 时自动检查并更新相关文档。
触发条件
当用户出现以下意图时,该技能会被激活:
- 要求创建拉取请求或 PR
- 说“submit my changes”或“push and create PR”
- 提到“make a PR”或“open a pull request”
- 希望提交代码以供审查
主要能力
该技能提供一套完整的 PR 创建工作流,包括:
-
分析变更:通过
git status、git diff、git log --oneline main..HEAD检查当前分支的所有变更,识别修改的文件、新增文件、删除文件以及受影响的技能或功能范围。 -
判断文档更新需求:检测
skills/目录是否有变更,并根据变更类型决定文档操作。例如:新增技能需在英文和中文 README 的技能表中添加条目;技能描述变更需更新描述;技能移除需从表中删除;技能钩子(hooks)变更需更新 Auto-Trigger 列;仅内部逻辑变更或无用户影响的 bug 修复可跳过 README 更新。 -
起草提交信息:采用 commit-helper 格式
<type>(<scope>): <subject>,类型包括 feat、fix、docs、refactor、chore。 -
创建 PR:依次执行暂存指定文件、提交、推送分支,并使用
gh pr create创建 PR。 -
更新文档:在提交或创建 PR 前,若变更影响用户可见的技能目录、安装或工作流行为,需同时更新 README.md(英文)和 README.zh-CN.md(中文),保持结构、格式和语言切换链接一致。
-
更新变更日志(可选):对重大变更,在 CHANGELOG.md 中按版本和日期记录 Added、Fixed、Changed 内容。
使用方式
技能通过自然语言触发,无需手动调用命令。典型使用流程为:用户提出创建 PR 的请求,技能自动执行分析、文档检查、提交和 PR 创建。文档中提供了常见场景的示例命令,例如新增技能时创建文件、通过包 CLI 安装或链接、更新两个 README、提交推送并创建 PR;修改现有技能时检查描述是否变化并更新 README;仅修复 bug 时无需更新 README。
适用场景
- 维护包含技能目录的双语仓库
- 需要确保英文和中文文档同步的代码提交
- 使用 Conventional Commits 规范提交信息的团队
- 通过 gh CLI 管理 PR 的工作流
限制
资料中未提供该技能对特定平台、收费、价格或具体效果的信息。技能的实际可用性可能依赖于仓库结构、gh CLI 的安装与认证,以及技能元数据中定义的触发条件。文档中提到的部分步骤(如 CHANGELOG 更新)标注为可选,具体执行需根据项目实际情况判断。