关于 jww-repository-validation
jww-repository-validation 是用于选择仓库变更验证方式的技能。它指导开发者先查阅项目指引,再按变更范围和风险选择检查,从文档审阅到定向测试。
主要功能
- 01检查仓库指引和自动化配置
- 02优先采用已记录的验证命令
- 03根据变更范围和风险选择检查
- 04在改变状态前先运行只读检查
- 05分类并报告检查结果
适用场景
- 01为代码变更选择检查
- 02验证文档或配置修改
- 03判断是否需要更广泛的集成检查
- 04报告跳过的检查和剩余风险
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ justin/ jww-skills --skill jww-repository-validation安装后在 Claude Code 中输入/jww-repository-validation确认已加载。
附带文件agents/openai.yaml
详细介绍
仓库验证
当没有其他说明时,可将此作为决定如何验证更改的通用后备方案。仓库说明和文档中记载的验证命令优先于这些默认规则。
验证应当适度,意味着检查的范围和成本应与更改的影响范围相匹配。运行足以覆盖已更改内容及其行为的最小检查集;随着更改影响范围扩大,再扩展到集成测试或端到端测试。
查找检查项
- 选择命令前,阅读适用的
AGENTS.md、README、贡献指南和相关自动化配置。 - 检查已更改的文件类型以及可用配置,例如
.editorconfig、包清单、CI 工作流、任务运行器,以及格式化工具或代码检查工具的设置。 - 优先采用现有文档中记载的检查,而不是自行设计新的检查。
选择适度的验证方式
- 文档:检查可读性并运行
git diff --check;如果仓库使用 Markdown 检查工具,也运行该工具。 - 源代码:在获准编辑时,仅格式化已更改的文件。运行能覆盖更改的定向测试、静态分析或构建。只读审查时,报告格式差异,不要修改文件。
- 配置、模板和脚本:对受影响的内容进行渲染、解析或试运行,并在适用时运行语法检查。
- 影响范围广或风险较高的更改:如有相关集成测试或端到端测试,则增加这些检查。
从只读检查开始。除非任务作者授权,否则不要仅为验证而安装依赖、应用配置、迁移数据、发布构件或以其他方式更改外部状态。
所需且相关的检查通过后,即可继续完成任务。仅当进一步的更改、失败或未解决的问题有此必要时,才扩大或重复验证。
报告结果
- 在宣布失败属于回归之前,先根据已更改的行为审查失败情况。
- 报告每条准确的命令或具名检查,并将其结果归类为:通过、与更改相关的失败、既有失败、环境阻碍或已跳过。
- 对于已跳过的检查,说明无法执行的原因或为何该检查不合比例,并指出仍然存在的风险。
评论
支持 Markdown