Community写作与编辑github.com

AnjanJ/shipkit

借助 Claude 提升代码质量。为 Claude Code 提供的技能、代理、规则和知识库。镜像自 codeberg.org/AnjanJ/shipkit

shipkit 是什么?

本技能为 Claude Code 提供了一套完整的质量保证工作流程,名为 `/qa`。它引导 AI 代理对最近的代码变更或指定文件进行系统性测试,覆盖从变更识别到测试编写、执行和最终报告的完整周期。技能支持检测 RSpec、Minitest、ExUnit、Jest/Vitest 和 Playwright 等主流测试框架,并自动分类文件风险等级(关键、高、中、低),以优先测试关键路径。工作流程分为五个阶段:侦察(识别变更和风险)、询问(向用户提出针对性问题)、计划(呈现结构化测试计划)、规格编写(遵循单一断言、描述性命名、Arrange-Act-Assert 等最佳实践)以及执行与验证(运行测试、修复失败、生成 QA 报告)。最终输出包含“发货”、“修复并重测”或“需要返工”的明确判决。

兼容平台✓Claude Code~Codex CLI~Cursor
npx skills add AnjanJ/shipkit

Installed? Explore more 写作与编辑 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

/qa — 质量保证工作流程

运行此技能以对最近的变更或特定文件进行全面的 QA。

最近更改的文件

!git diff --name-only HEAD~1 2>/dev/null | head -20 || echo "未检测到最近的更改"

阶段 1:侦察

  1. 检测测试框架 — 检查以下内容:
    • 包含 rspec/minitest 的 Gemfile → RSpec 或 Minitest
    • mix.exs → ExUnit
    • 包含 jest/vitest 的 package.json → Jest 或 Vitest
    • playwright.config → Playwright
  2. 识别更改的文件 — 如果 $ARGUMENTS 是文件路径,则使用该路径;否则运行 git diff --name-only HEAD~1
  3. 按风险级别对每个文件进行分类:
    • 关键:身份验证、支付、数据模型、共享工具、API 端点
    • 高:业务逻辑、服务、控制器
    • 中:视图、序列化器、辅助函数、配置
    • 低:文档、注释、格式化
  4. 读取每个更改的文件及其现有测试(如有)。如果更改的文件超过约 5 个, 将此读取任务委托给 codebase-explorer 代理,并根据其摘要 工作——将主要上下文保留用于问题和测试。
  5. 构建上下文表格:
文件类型风险现有测试?
............

阶段 2:询问

在编写任何测试之前,使用 AskUserQuestion 提出 3-8 个探查性问题。 分组提问——不要逐个询问。

好问题(关注风险):

  • "这会触及支付流程——我应该测试退款边界情况吗?"
  • "新的验证拒绝了空白输入。那么纯 Unicode 字符串呢?"
  • "此服务调用外部 API——我应该模拟它还是测试集成?"

坏问题(不要问这些):

  • "这段代码是做什么的?"(自己阅读)
  • "我应该编写测试吗?"(是的,总是)
  • "我应该使用什么测试框架?"(检测它)

阶段 3:测试计划

在编写任何规格之前呈现结构化的测试计划。 按类别组织:

测试类别

  1. 快乐路径 — 预期输入产生预期输出
  2. 边界情况 — 边界值、空输入、最大值、nil/null
  3. 错误情况 — 无效输入、网络故障、超时、权限被拒绝
  4. 怪异/对抗性 — SQL 注入字符串、脚本标签、表情符号、10MB 字符串、并发访问
  5. 性能 — N+1 查询、无界集合、慢查询(仅针对关键/高风险)
  6. 集成 — 组件之间的交互(仅在多个文件更改时)

以表格形式呈现:

#类别测试描述风险级别
1快乐路径使用有效参数创建记录高
............

等待用户批准后再继续。

阶段 4:规格编写

遵循以下模式编写规格:

  • 每个测试一个断言(实际可行时)
  • 描述性名称 — it "在记录未找到时返回 404" 而不是 it "有效"
  • Arrange-Act-Assert 结构
  • 无神秘来宾 — 所有测试数据在测试中可见
  • 测试行为而非实现 — 不要直接测试私有方法
  • 使用工厂/夹具 — 适合所选框架
  • 按行为分组 — 使用 describe/context 块

测试代码质量

测试也是代码——适用同样的原则:

  • KISS(保持简单): 不要过度设计测试辅助工具。如果设置超过 10 行,简化测试或被测代码。
  • YAGNI(不需要就不用): 不要测试不可能发生的场景。不要为了“以防万一”而针对不可能的状态添加测试。
  • DRY(适度): 在清晰的重复和巧妙的共享示例之间,倾向于清晰的重复。测试应能从上到下阅读,无需跳转到 3 个辅助文件。
  • 整洁代码: 描述性的测试名称,读起来像文档。没有神秘来宾——所有数据在测试中可见。

有关特定于框架的测试说明,请参见 @reference.md(RSpec、Minitest、ExUnit、Jest/Vitest)。

阶段 5:执行与验证

  1. 运行新规格 — 针对性地运行(仅新文件)
  2. 修复任何失败 — 读取错误、读取源代码、修复根本原因
  3. 运行整个测试套件 — 确保没有破坏其他内容
  4. 生成 QA 报告 — 参见 @reference.md 中的报告模板、核心价值审计和合理化检查。

判决: 发货 / 修复并重测 / 需要返工

相关技能