分支与PR规范执行器
通过强制链接已批准issue、类型标签和自动化检查,规范化创建拉取请求的流程。
技能要求每个PR必须关联已批准的issue,并定义清晰的检查流程,这有助于防止未授权变更。但技能本身不包含权限最小化或用户确认的细节,依赖外部GitHub Actions强制执行,无法验证其配置是否安全。未发现恶意行为,但数据流和外部影响披露不完整,因此扣除部分分数。
技能提供了明确的规则和命令,但作为文档,没有自动化测试覆盖其关键路径。依赖shellcheck和GitHub Actions,但未验证这些检查是否在技能内完整实现。错误处理说明不足,失败信息不明确,因此仅得7分。
技能场景清晰,适用于创建PR,但未明确说明不适用的情况(例如非GitHub环境)。触发条件描述具体,但边界条件不完整。由于是英文内容,对中文用户支持有限,且GitHub在中国大陆可能无法直接访问,已扣除部分分数。
技能文档结构清晰,有版本号和作者信息,但缺少变更日志和已知限制。依赖外部模板和CI,未提供完整安装或依赖说明。维护责任未明确,因此扣除部分分数。
技能描述了创建PR的完整流程,预期输出明确,但缺乏实证验证其实际效果。文档中的命令和模板需要用户手动执行,可能存在偏差。边际价值有限,因为多数开发者熟悉GitHub PR流程,因此仅得7分。
静态评估无法执行任何测试,仓库中的CI工作流和测试主要针对主项目,并非此技能。技能本身没有提供可验证的执行证据,且依赖外部服务,因此仅得3分。
- 技能依赖GitHub和GitHub Actions,这些服务在中国大陆可能无法直接访问,建议提供替代方案或明确告知用户网络要求。
- 技能文档为英文,未提供中文版本,可能影响中文用户理解和使用。
- 技能的部分规则(如强制关联issue)可能不适用于所有项目或团队,使用前需确认其是否符合所在组织的政策。
这个 Skill 能做什么,适合哪些场景?
该技能为创建拉取请求提供了一套严格的规范流程,确保每个PR都关联一个已批准的issue、添加一个类型标签,并通过自动化检查。它定义了分支命名规则、PR模板、提交消息约定以及验证GitHub Actions检查的各个环节。适用于需要保持PR一致性和可追溯性的团队。
技能指导用户遵循以下步骤:验证issue是否带有status:approved标签,按照type/description格式创建分支,使用符合约定的提交消息,运行shellcheck检查脚本,使用PR模板并添加一个类型标签,最后等待自动化检查通过。它还会验证提交消息是否符合规定的正则表达式,并据此映射到相应的PR标签。
- 希望确保每个PR都关联已批准issue的开发团队,避免无关联PR。
- 需要统一分支命名和提交规范的新项目,以保持历史清晰。
- 维护者希望利用GitHub Actions自动阻止不合格PR的存储库。
- 贡献者希望快速了解如何正确提交PR并避免被CI拒绝。
- 希望实施约定式提交的团队,确保提交类型与PR标签一致。
这个 Skill 有哪些优点和局限?
- 强制执行PR规范,提高一致性。
- 通过强制关联issue和类型标签,提升可追溯性。
- 自动化检查减少人工审查负担。
- 分支命名和提交消息规则明确,易于遵循。
- 仅提供指导,实际执行依赖GitHub Actions工作流(未包含在技能中)。
- 要求所有PR关联已批准issue,可能不适用于某些项目流程。
- 依赖shellcheck,可能不适用于非Shell脚本项目。
- 技能本身未附带测试,需依赖外部CI验证。
如何安装这个 Skill?
该技能是gentle-ai集合的一部分,可通过仓库安装:git clone https://github.com/Gentleman-Programming/gentle-ai,然后将internal/assets/skills/branch-pr文件夹复制到您的技能目录。
如何使用这个 Skill?
在创建PR时,调用该技能描述中的触发词,例如:“正在为feat/user-login创建PR,请确保遵循branch-pr技能。” 或者按照工作流手动执行:从main分支创建feat/my-feature分支,运行shellcheck,推送并创建PR,添加类型标签。技能还提供了具体命令,如gh pr create --title "feat(scope): description" --body "Closes #N"。