关于 gjalla-prepare-and-commit
gjalla-prepare-and-commit 是一项帮助代码变更达到可审查、可提交状态的技能。它指导验证工作、编写面向审查者的变更报告、规划提交,并在提交前创建 gjalla attestation。
主要功能
- 01检查实现与需求
- 02记录验证依据
- 03提交变更报告供审查
- 04规划精简提交并暂存文件
- 05创建 gjalla attestation
适用场景
- 01请求审查前检查变更
- 02汇总测试与完成标准
- 03将无关改动拆分为多个提交
- 04准备带 gjalla attestation 的提交
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ gjalla/ engineering --skill gjalla-prepare-and-commit安装后在 Claude Code 中输入/gjalla-prepare-and-commit确认已加载。
详细介绍
让你的更改达到可提交状态
将已完成的更改完善为可提交的状态,让审阅者和未来的读者都能信赖。
1. 审查你的实现
- 是否满足所有验证标准和预期结果?
- 实现是否完整(没有遗留虚拟数据或占位桩)?
- 是否满足所有 gjalla 规则?
- 是否优雅地基于现有状态/架构/属性进行构建,或在其中实现?
- 是否符合计划/gjalla 规范?
- 是否充分测试了正向、负向和边界情况?
- 代码审查流程是否已经完成?
如果以上任一问题的答案是否定的,请确定需要进行哪些更改。我们绝不能容忍打地鼠式的修补。最好退一步,为任何问题设计优雅且可持续的解决方案。如果需要人工审查某项权衡,你可以向用户询问。
当你能够确信所有问题的答案都是“是”后,请记录你验证过的内容(运行了哪些测试套件、退出码、DoD 项目),让更改摘要有证据支撑,而不只是空口声称。
2. 展示流程(第二个人工关卡)
-
为人工审阅者撰写一份简短的更改报告,说明你经历的阶段、各阶段的证据(审查、测试运行、DoD)以及对系统的影响。
-
这份报告是人工关卡:“以下是我经历的阶段、各阶段的证据(审查、测试运行、里程碑)以及对系统的影响。”除非用户已针对低风险更改给予长期授权,否则在最终定稿前应向人工审阅者展示报告或其关键要点。
3. 制定提交计划
- 每个提交只包含一项逻辑更改。如果差异中包含两项互不相关的内容,不要犹豫,将它们拆分(
git add -p)。 - 精确暂存文件——批量暂存(
git add -A/-u/.)可能会让无关的进行中工作混入你的提交。 - 确保提交到正确的分支,和/或遵循预期的分支策略。
- 准备好分别向 git(代码级更改)和 gjalla(系统级更改)报告的内容。
- 确保 gjalla git hooks 已就位。如果没有,你的认证和规范将无法与主事实来源同步。
4. 提交
- 编写你的 gjalla 认证。
gjalla attest --example会展示格式,确保查看完整输出(例如,不要运行命令后将输出管道到2>/dev/null)。 - 编写提交消息并执行提交。你的 gjalla 认证和规范会通过 git hooks 与 gjalla 同步,无需额外操作。
- 除非用户已给予你全面授权,否则在推送提交前最好先询问用户。
评论
支持 Markdown