mcpField
S
ship-check

ship-check

github.com/tahajemmali测试与质量085 次安装29 周前更新
代码仓库

关于 ship-check

用于在代码或文档变更后指导 Agent 执行收尾检查的编排技能。它依次调用仓库内的审查与文档维护技能，再汇总发现和未完成的验证。

主要功能

  1. 01按顺序调用两个仓库审查技能
  2. 02依据仓库规范检查代码变更
  3. 03评估文档维护需求
  4. 04汇报验证状态与发现
  5. 05定义批准或备注结论

适用场景

  1. 01交付前审查已完成的代码变更
  2. 02检查是否需要更新仓库文档
  3. 03汇总审查结果和未运行的测试
  4. 04额外编辑后重新执行检查

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/tahajemmali/skills --skill ship-check

安装后在 Claude Code 中输入/ship-check确认已加载。

详细介绍

发布检查

概述

在代码或文档更改后，运行仓库的任务结束验证流程。

这是一项编排技能，不会取代专门的审查技能。它会告诉 Agent 应按什么顺序运行哪些检查，以及在最终交接前如何总结结果。

标准流程

完成修复、重构或功能开发后，使用此流程：

  1. 使用 $review-changes 审查最新更改。
  2. 使用 $repo-doc-maintainer 检查项目文档是否需要维护。
  3. 清楚地报告两项检查的综合结果。
  4. 如果更改了代码，提醒用户注意尚未运行的验证命令。

调用模式

调用此技能时，必须依次明确使用其他仓库本地技能。

首先运行：

Use $review-changes to review the latest changes against the project's guidelines and report findings first.

然后运行：

Use $repo-doc-maintainer to review the latest changes and decide whether project documentation should be updated.

除非用户明确缩小范围，否则不要跳过任何一步。

如何解读结果

如果 review-changes 发现问题
  • 首先列出发现的问题
  • 不要声称工作已通过验证
  • 如果问题可操作且局限于本地，在适当情况下应在最终交接前修复
  • 如果再次更改代码，修复后重新运行验证
如果 review-changes 未发现问题
  • 说明更改符合当前仓库指南
  • 仍需运行 $repo-doc-maintainer
如果 repo-doc-maintainer 表示需要更改文档
  • 如果当前任务包含这些维护性修改，则更新文档
  • 否则，报告建议进行文档维护
如果 repo-doc-maintainer 表示无需更新文档
  • 在最终收尾说明中明确指出这一点

输出要求

最终收尾应综合两项检查：

  • 实现是否通过仓库规则审查
  • 是否需要维护文档
  • 项目验证命令是否已运行，或仍有待运行

保持输出简洁。除非确有问题，否则优先使用简短的状态摘要，而非冗长的清单。

约束

  • 将 $review-changes 视为仓库规则合规性审查的权威依据。
  • 将 $repo-doc-maintainer 视为文档维护决策的权威依据。
  • 不要在此处另行制定第三套审查标准。
  • 在工作结束时使用此技能，不要在开始实现前使用。

验证流程

完成实现工作后，使用此检查清单。

必需的审查技能

  1. $review-changes
  2. $repo-doc-maintainer

默认顺序

  1. 检查最新工作树或提交范围。
  2. 通过 $review-changes 进行仓库规则审查。
  3. 通过 $repo-doc-maintainer 进行文档维护审查。
  4. 总结两项结果。

最终收尾应涵盖

  • 更改是否遵循项目的书面指南
  • 项目文档是否需要更新
  • 验证命令（lint、test、analyze）是否已运行
  • 任何遗留风险，例如尚未运行的测试或仅通过手动方式验证的缺口

何时重新运行

如果首次验证后又进行了代码或文档修改，请重新运行此流程。

结束信号

最终收尾后，始终单独一行输出判定：

  • VERDICT: APPROVED — 如果 review-changes 和 repo-doc-maintainer 均通过，且没有待解决的代码或文档问题
  • VERDICT: REMARKS — 如果 review-changes 发现实际代码问题，或 repo-doc-maintainer 发现本次运行中未解决的文档缺漏

在以下情况下使用 VERDICT: APPROVED：

  • review-changes 通过（没有代码问题）
  • repo-doc-maintainer 未发现需要修改的内容，或本次运行中已完成所需修改
  • 无法运行需要外部基础设施（Docker 守护进程、云服务、设备模拟器等）的验证命令——这是预期情况，不构成降级为 REMARKS 的理由
  • 本次运行中更新了计划复选框或其他记录事项——常规维护不属于问题

仅当存在实际未解决的问题时，才使用 VERDICT: REMARKS——例如真实的代码问题、未修复的文档缺漏或测试失败。若备注仅包含信息说明（例如“docker build 需要手动验证”），应将其放在收尾摘要中，不影响批准。

使用 REMARKS 时，请包含发现：

VERDICT: REMARKS

FINDINGS_START
- review-changes: <summary of actual code issues>
- repo-doc-maintainer: <summary of unresolved doc gaps>
FINDINGS_END

VERDICT: 行必须是最后一条实质性输出。使用 FINDINGS_START/FINDINGS_END 分隔符时，须将它们单独放在一行。

评论

支持 Markdown