SuperAPI AI 工具集

gjalla-prepare-and-commit

编程与开发

查看项目

更新于 10-15 14:24

技能介绍

用途

gjalla-prepare-and-commit 是一个面向提交前阶段的工程技能,目标是把一个“能跑通”的改动,转化为“可提交”的改动,使代码审查者和未来的读者能够信任这次变更。它强调在真正执行 git commit 之前,先完成实现审查、人工确认和提交规划。

主要能力

该技能围绕四个阶段展开:

  1. 审查实现:确认所有验证标准与预期结果是否达成;实现是否完整(没有遗留假数据或占位桩);是否满足全部 gjalla 规则;是否优雅地建立在现有状态、架构与属性之上;是否与计划或 gjalla 规范一致;正向、负向和边界用例是否得到显著测试;代码审查流程是否已完成。若任一问题答案为“否”,需要判断所需改动,明确反对“打地鼠式”的零散修补,宁可退一步设计优雅且可持续的解决方案;若存在需要人工权衡的取舍,可以提示用户。当能自信回答“是”后,记录已验证的内容(运行了哪个测试套件、退出码、DoD 条目),使变更摘要携带证据而非仅凭声明。

  2. 呈现过程(第二个人工关口):为人类写一份简短的变更报告,说明经历的各阶段、每个阶段的证据(审查、测试运行、DoD)以及系统影响。该报告即人工关口,在封存前应将其或要点呈现给人类,除非用户已对低风险变更给予长期批准。

  3. 制定提交计划:每个提交只包含一个逻辑变更;如果 diff 做了两件不相关的事,可用 git add -p 拆分;精确暂存文件,避免使用 git add -A/-u/. 这类批量暂存,以免把无关的进行中工作混入提交;确认提交到正确分支或遵循预期的分支策略;准备向 git 报告的代码级变更和向 gjalla 报告的系统级变更;确保 gjalla git 钩子已就位,否则证明与规范不会同步到主事实源。

  4. 提交:撰写 gjalla 证明(可用 gjalla attest --example 查看格式,并查看完整输出,不要将命令输出通过 2>/dev/null 管道丢弃);撰写提交信息并执行提交;gjalla 证明与规范会作为 git 钩子的一部分与 gjalla 同步,无需额外操作。除非用户给予全面许可,否则推送提交前应询问用户。

使用方式

该技能在提交代码之前使用。它不是一个自动化命令,而是一套需要逐步执行的流程:先自查实现,再向人类呈现变更报告,然后规划提交,最后执行提交。其中涉及 gjalla 工具链(gjalla attest、gjalla git hooks)以及 git 操作(git add -p、git commit)。

适用场景

适用于需要将工作区改动整理为干净、原子提交的开发者,尤其是使用 gjalla 工程规范与 git 钩子同步证明和规范的团队。适合在代码审查完成后、正式提交前使用。

限制

资料未提供该技能的具体安装命令、支持的平台、收费方式或价格信息。资料也未说明其与哪些具体编程语言或框架绑定。推送前是否需要询问用户取决于用户是否已授予全面许可。