SuperAPI AI 工具集

git-precommit

部署与运维

查看项目

更新于 10-16 08:55

技能介绍

用途

Git 提交前工作流(编排器)是一个用于协调 Git 提交前准备工作的技能。它的定位是编排器,即协调多个 Skills 共同完成提交前的所有准备步骤。

触发条件

当用户表达以下意图时加载本技能:

  • 「准备 commit」
  • 「要提交了」
  • 「git commit」
  • 用户想要 commit、push、submit 代码,或说「準備提交」「要 commit 了」等

执行流程

该技能按以下六个步骤编排提交前工作流:

  1. [必要] memory-sync:Memory Bank 同步
  2. [可选] readme-update:README 更新
  3. [可选] changelog-update:CHANGELOG 更新
  4. [可选] roadmap-update:ROADMAP 更新
  5. [条件] arch-check:架构文档检查
  6. [最终] commit-prepare:准备提交

参数

参数 说明 默认
--skip-readme 跳过 README 更新 false
--skip-changelog 跳过 CHANGELOG 更新 false
--skip-roadmap 跳过 ROADMAP 更新 false
--dry-run 只预览不修改 false
--quick 只执行必要步骤 (memory-sync) false

使用方式

以自然语言指令触发,例如:

  • 「准备 commit」:执行完整流程
  • 「快速 commit」:等同 --quick
  • 「commit --skip-readme」:跳过 README 更新

输出格式

技能以分步格式输出各步骤执行结果,示例结构如下:

🚀 Git Pre-Commit 工作流

[1/6] Memory Bank 同步 ✅
  └─ progress.md: 更新 2 项
  └─ activeContext.md: 已更新

[2/6] README 更新 ✅
  └─ 新增功能说明

[3/6] CHANGELOG 更新 ✅
  └─ 添加 v0.2.0 条目

[4/6] ROADMAP 更新 ⏭️ (无变更)

[5/6] 架构文档 ⏭️ (无结构性变更)

[6/6] Commit 准备 ✅
  └─ 建议讯息:feat: 新增用户认证模组

📋 Staged files:
  - src/auth/...
  - docs/...

准备好了!确认提交?

规范依据

  • 宪法:CONSTITUTION.md 第三章
  • 子法:.github/bylaws/git-workflow.md

适用场景与限制

适用于采用该技能所处项目的 Git 工作流规范、需要在提交前统一同步项目文档(Memory Bank、README、CHANGELOG、ROADMAP、架构文档)的场景。步骤的必选、可选与条件属性由技能定义决定,其中 memory-sync 为必要步骤,commit-prepare 为最终步骤,arch-check 为条件触发。其他细节(如具体实现依赖、兼容平台、收费情况)暂未提供。