AI辅助编码的Git工作流规范 - PR + Commit Workflow

AI辅助编码的Git工作流规范

收藏 11.3k
下载 3.2k
版本 1.0.0

开源PR/Commit工作流规范工具,强制人工意图声明与证据链管理,适合AI辅助编码场景,个人开发者维护需关注更新频率

基本信息

  • 技能名称?PR + Commit Workflow
  • 中文名称?AI辅助编码的Git工作流规范
  • 作者?joshp123
  • 分类?专业技能
  • 版本?1.0.0
  • 标签?git, pull-request, commit, workflow, ai-coding, agpl, cli, version-control

使用方法

使用说明
核心用法
pr-commit-workflow 是一套针对现代 AI 辅助开发场景的 Git 工作流规范工具,分为两个独立入口:
Commit 工作流 :通过 references/workflow-commit.md 执行提交检查,使用 references/commit-format.md 的标准化消息格式
PR 工作流 :通过 references/workflow-pr.md 创建或更新 PR,强制使用 references/pr-human-template.md 的人工编写模板,并调用 scripts/build_pr_body.sh 收集环境元数据(AI 模型信息、终端类型等)
关键约束:PR 必须包含用户提供的 人工编写意图 ,禁止 AI 生成或改写。
显著优点

  1. 证据链完整性 :通过 build_pr_body.sh 自动捕获编码环境( CODEX_MODEL 、 CLAUDE_MODEL 等),提升 PR 可审计性
  2. 人类可读性优先 :强制使用人工编写的 PR 模板结构,避免 AI 生成内容的同质化
  3. 零依赖设计 :纯本地脚本,无外部 API 调用,启动即用的安全边界
  4. AGPL-3.0 开源 :代码完全可审计,支持 Fork 定制
    潜在缺点与局限
    T3 来源风险 :个人开发者(joshp123)单点维护,缺乏基金会背书或企业级 SLA
    环境变量读取 :需读取多个 AI 模型的环境变量,虽符合声明功能,但用户需知情共享内容
    模板刚性 : pr-human-template.md 必须"verbatim"使用,灵活性受限
    无网络功能 :无法自动同步 GitHub 评论状态或 CI 检查结果
    适合人群
    使用 Cursor/Codex/Claude 等 AI 工具进行严肃开发的个人开发者
    希望建立可审计 AI 辅助编码记录的技术团队
    对 Git 历史整洁度和 PR 可读性有要求的项目
    常规风险
    维护连续性 :个人项目存在维护中断风险,建议生产环境 Fork 后自行维护
    信息泄露 : build_pr_body.sh 收集的环境元数据可能包含敏感信息,共享 PR 前需人工审查
    模板误用 :严格遵守 "verbatim" 要求,擅自修改模板可能导致工作流失效
    版本漂移 :引用文件( references/*.md )路径依赖需随 skill 更新同步调整

标签

专业技能

💬 评论 (0)

发表评论

支持 Markdown

📭 还没有评论,快来抢沙发吧!