feat(skills): 新增 gitlink-cli-contract-guard CLI 契约守卫 Skill #299

Merged
wbtiger merged 1 commits from Mengz/gitlink-cli:mengz/skill-cli-contract-guard-submit into master 2026-07-14 22:30:40 +08:00
Contributor

Skill 解决的问题

原来的 gitlink-ci-health 依赖仓库 CI 状态,但很多 GitLink 仓库并没有稳定可用的 CI 信号,实际帮助有限。相比之下,社区更常见、也更容易被忽略的问题,是 CLI 改动在不经意间破坏了已有命令契约,例如 flag 语义漂移、帮助文案失真、--format json 输出结构变化、中文错误提示乱码等。这个 skill 的目标就是在合并前把这类兼容性风险系统性挑出来。

Skill 能做什么

  • 审查 GitLink CLI 改动是否破坏既有 flags、默认值、命令层级、帮助文本和 JSON 输出结构。
  • 检查错误提示、编码质量、README 与示例命令是否和真实行为漂移。
  • 区分参数契约、帮助契约、输出契约、错误契约、文档契约五个审查面,避免只看代码风格而遗漏对用户最敏感的兼容性问题。
  • 给出 blocking/high/medium/low 的契约风险分级,适合作为命令类 PR 的合并前守门审查。

这次提交包含的内容

  • 删除旧的 skills/gitlink-ci-health/
  • 新增 skills/gitlink-cli-contract-guard/SKILL.md,围绕 CLI 契约兼容性重新定义 skill。
  • 新增 references/contract-surfaces.mdreferences/severity-rubric.md,分别约束审查面和严重级别判定。
  • 新增 3 份 example prompt,覆盖 flag 兼容性、JSON 输出结构、中文编码与文档漂移审查。
  • 新增 Codex 验证输出文档 examples/codex-validation-2026-06-26.md
  • 新增截图材料:skill 目录截图 1 张、运行结果截图 1 张。

如何复核与验证

我已按 skills 规范执行 quick_validate.py,结果通过。随后在 Codex 中使用该 skill 审查 Gitlink/gitlink-cli 的 PR #290。skill 能明确判断该 PR 只改动 skill 文档与图片资产,没有触碰 cmd/shortcuts/、输出层、错误处理与帮助文本,因此不会破坏现有 CLI 契约;同时也验证了中文内容可读、git diff --check 通过、契约面没有 blocking/high/medium 问题。完整结果已放进验证文档。

已附材料

  • skills/gitlink-cli-contract-guard/examples/codex-validation-2026-06-26.md
  • skills/gitlink-cli-contract-guard/assets/codex-skill-directory.png
  • skills/gitlink-cli-contract-guard/assets/codex-validation-output.png
## Skill 解决的问题 原来的 `gitlink-ci-health` 依赖仓库 CI 状态,但很多 GitLink 仓库并没有稳定可用的 CI 信号,实际帮助有限。相比之下,社区更常见、也更容易被忽略的问题,是 CLI 改动在不经意间破坏了已有命令契约,例如 flag 语义漂移、帮助文案失真、`--format json` 输出结构变化、中文错误提示乱码等。这个 skill 的目标就是在合并前把这类兼容性风险系统性挑出来。 ## Skill 能做什么 - 审查 GitLink CLI 改动是否破坏既有 flags、默认值、命令层级、帮助文本和 JSON 输出结构。 - 检查错误提示、编码质量、README 与示例命令是否和真实行为漂移。 - 区分参数契约、帮助契约、输出契约、错误契约、文档契约五个审查面,避免只看代码风格而遗漏对用户最敏感的兼容性问题。 - 给出 blocking/high/medium/low 的契约风险分级,适合作为命令类 PR 的合并前守门审查。 ## 这次提交包含的内容 - 删除旧的 `skills/gitlink-ci-health/`。 - 新增 `skills/gitlink-cli-contract-guard/SKILL.md`,围绕 CLI 契约兼容性重新定义 skill。 - 新增 `references/contract-surfaces.md` 与 `references/severity-rubric.md`,分别约束审查面和严重级别判定。 - 新增 3 份 example prompt,覆盖 flag 兼容性、JSON 输出结构、中文编码与文档漂移审查。 - 新增 Codex 验证输出文档 `examples/codex-validation-2026-06-26.md`。 - 新增截图材料:skill 目录截图 1 张、运行结果截图 1 张。 ## 如何复核与验证 我已按 skills 规范执行 `quick_validate.py`,结果通过。随后在 Codex 中使用该 skill 审查 `Gitlink/gitlink-cli` 的 PR #290。skill 能明确判断该 PR 只改动 skill 文档与图片资产,没有触碰 `cmd/`、`shortcuts/`、输出层、错误处理与帮助文本,因此不会破坏现有 CLI 契约;同时也验证了中文内容可读、`git diff --check` 通过、契约面没有 blocking/high/medium 问题。完整结果已放进验证文档。 ## 已附材料 - `skills/gitlink-cli-contract-guard/examples/codex-validation-2026-06-26.md` - `skills/gitlink-cli-contract-guard/assets/codex-skill-directory.png` - `skills/gitlink-cli-contract-guard/assets/codex-validation-output.png`
Mengz added 1 commit 2026-06-26 12:36:45 +08:00
wbtiger merged commit 7e2d3ea6f1 into master 2026-07-14 22:30:38 +08:00
Sign in to join this conversation.
No reviewers
No Label
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Gitlink/gitlink-cli#299
No description provided.