Back to Details

ship-check

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Ship Check

发布检查

Overview

概述

Run the repo's end-of-task validation flow after code or documentation changes.
This is an orchestration skill. It does not replace the specialized review skills. It tells the agent which checks to run, in what order, and how to summarize the result before final handoff.
在代码或文档变更后运行代码仓库的任务结束验证流程。
这是一项编排Skill，它不会替代专门的审查Skill。它会告知Agent需要运行哪些检查、按什么顺序运行，以及在最终交接前如何汇总结果。

Standard Flow

标准流程

Use this flow after finishing a fix, refactor, or feature:
  1. Review the latest changes with 
    $review-changes
    .
  2. Check whether project documentation needs maintenance with 
    $repo-doc-maintainer
    .
  3. Report the combined outcome clearly.
  4. If code changed, remind the user about any validation commands not yet run.
在完成修复、重构或功能开发后使用此流程：
  1. 使用
    $review-changes
    审查最新变更。
  2. 使用
    $repo-doc-maintainer
    检查项目文档是否需要维护。
  3. 清晰上报合并后的结果。
  4. 如果代码发生了变更，提醒用户所有尚未运行的验证命令。

Invocation Pattern

调用模式

When this skill is invoked, explicitly use the other repo-local skills in sequence.
Start with:
Use $review-changes to review the latest changes against the project's guidelines and report findings first.
Then run:
Use $repo-doc-maintainer to review the latest changes and decide whether project documentation should be updated.
Do not skip either step unless the user explicitly narrows the scope.
调用该Skill时，需要按顺序显式调用其他代码仓库本地Skill。
首先运行：
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.
除非用户明确缩小了范围，否则不得跳过任意步骤。

How To Interpret Results

结果解读方法

If 
review-changes
finds issues

如果
review-changes
发现问题

  • present the findings first
  • do not claim the work is validated
  • if the issues are actionable and local, fix them before final handoff when appropriate
  • rerun validation after fixes if you changed the code again
  • 首先展示发现的问题
  • 不得声称工作已通过验证
  • 如果问题是可执行且局部的，合适的话可以在最终交接前修复这些问题
  • 如果你再次修改了代码，修复后需要重新运行验证

If 
review-changes
finds no issues

如果
review-changes
未发现问题

  • say that the changes comply with the current repo guidance
  • still run 
    $repo-doc-maintainer
  • 说明变更符合当前代码仓库的规范
  • 仍需运行
    $repo-doc-maintainer

If 
repo-doc-maintainer
says docs should change

如果
repo-doc-maintainer
指出需要修改文档

  • update the docs if the current task includes making those maintenance edits
  • otherwise report that documentation maintenance is recommended
  • 如果当前任务包含这些维护编辑工作，则更新文档
  • 否则上报建议进行文档维护

If 
repo-doc-maintainer
says no doc update is needed

如果
repo-doc-maintainer
指出无需更新文档

  • state that explicitly in the final close-out
  • 在最终收尾中明确说明这一点

Output Expectations

输出要求

The final close-out should combine both checks:
  • whether the implementation passed the repo-rule review
  • whether documentation maintenance was needed
  • whether project validation commands were run or remain outstanding
Keep the output compact. Prefer a brief status summary over a long checklist unless there are actual findings.
最终收尾需要合并两项检查的结果：
  • 实现是否通过了代码仓库规则审查
  • 是否需要进行文档维护
  • 项目验证命令是否已运行，或仍有未完成的
保持输出简洁。除非有实际发现，否则优先使用简短的状态汇总，而非冗长的检查清单。

Constraints

约束条件

  • Treat 
    $review-changes
    as the source of truth for repo-rule compliance review.
  • Treat 
    $repo-doc-maintainer
    as the source of truth for doc-maintenance decisions.
  • Do not invent a separate third review rubric here.
  • Use this skill at the end of work, not before implementation starts.
  • 将
    $review-changes
    作为代码仓库规则合规性审查的事实来源。
  • 将
    $repo-doc-maintainer
    作为文档维护决策的事实来源。
  • 不得在此处自行创建额外的第三套审查规则。
  • 仅在工作结束时使用该Skill，不要在实现工作开始前使用。

Validation Flow

验证流程

Use this checklist after finishing implementation work.
Required Review Skills
  1. $review-changes
  2. $repo-doc-maintainer
Default Sequence
  1. Inspect the latest working tree or commit range.
  2. Run the repo-rule review via 
    $review-changes
    .
  3. Run the doc-maintenance review via 
    $repo-doc-maintainer
    .
  4. Summarize both results.
Final Close-Out Should Cover
  • whether the changes respect the project's documented guidelines
  • whether project documentation needed updates
  • whether validation commands (lint, test, analyze) were run
  • any residual risks, such as unrun tests or manual-only verification gaps
When To Re-Run
Re-run the flow if you make additional code or doc edits after the first validation pass.
完成实现工作后使用此检查清单。
必填审查Skill
  1. $review-changes
  2. $repo-doc-maintainer
默认顺序
  1. 检查最新的工作树或提交范围。
  2. 通过
    $review-changes
    运行代码仓库规则审查。
  3. 通过
    $repo-doc-maintainer
    运行文档维护审查。
  4. 汇总两项检查的结果。
最终收尾需涵盖
  • 变更是否符合项目已记录的规范
  • 项目文档是否需要更新
  • 验证命令（lint、test、analyze）是否已运行
  • 任何剩余风险，例如未运行的测试或仅支持手动验证的缺口
何时需要重新运行
如果你在首次验证通过后又进行了额外的代码或文档编辑，请重新运行该流程。

Closing Signal

收尾信号

After the final close-out, always emit a verdict on its own line:
  • VERDICT: APPROVED
    — if both checks passed with no outstanding issues
  • VERDICT: REMARKS
    — if issues were found or remain unresolved, followed by a structured findings block:
**Findings:**
- review-changes: <summary of issues, or "passed">
- repo-doc-maintainer: <summary of doc recommendations, or "no changes needed">
- validation commands: <any outstanding commands not yet run, or "all run">
The 
VERDICT:
line must be the last substantive output.
最终收尾后，始终单独占一行输出判定结果：
  • VERDICT: APPROVED
    — 两项检查均通过，无未解决问题
  • VERDICT: REMARKS
    — 发现问题或仍有未解决问题，后面附上结构化的发现块：
**Findings:**
- review-changes: <summary of issues, or "passed">
- repo-doc-maintainer: <summary of doc recommendations, or "no changes needed">
- validation commands: <any outstanding commands not yet run, or "all run">
VERDICT:
行必须是最后一条实质性输出。