mcpField
E
escribir-contrato

escribir-contrato

github.com/adminoryslabs开发011 次安装1 周前更新
代码仓库

关于 escribir-contrato

这项西班牙语 Skill 将用户故事和项目决策整理为面向测试人员与开发者的可观察行为契约,并支持版本管理。遇到未解决的需求时先提问;提交契约和问题后即停止。

主要功能

  1. 01整理范围明确的上下文包
  2. 02定义可观察的接口行为
  3. 03将案例对应到验收标准
  4. 04标记待审议的提议决策
  5. 05通过变更日志管理版本
  6. 06停止于实现或发布之前

适用场景

  1. 01明确 HTTP、界面、命令或事件行为
  2. 02为测试人员和开发者提供共同契约
  3. 03在开发前澄清需求缺口

安装

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

$npx skills add https://github.com/adminoryslabs/armory --skill escribir-contrato

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

附带文件assets/contrato-template.md

详细介绍

编写契约

目标

产出 TESTER 和 DEV 唯一会阅读的文档:从外部视角描述 HU 必须实现什么,并提供足够精确的信息,确保两个互不交流的 Agent 得出相同结果。契约定义可观察的行为;内部实现由 DEV 自行决定。

**此 skill 不构建任何内容。**只负责编写、提问,然后停止。

输入

  • HU — 如果已连接,则通过 Jira 的 MCP 获取;否则使用指定的文件或链接。如果存在尚未解决的未决事项,请停止:须先升级处理,再编写契约。
  • TECH-DESIGN.md — 与此 HU 对应的章节及验收标准。
  • adrs/ — 仅限此 HU 的故事 ADR(以及会影响其接口的跨领域 ADR,例如 API 风格)。
  • AGENTS.md — 项目约定。
  • contratos/ 中的既有契约 — 避免与已确定的名称冲突。

工作流

  1. **整理上下文包:**HU + 适用的 ADR + TDD 章节,仅此而已。列出纳入了哪些内容,以及纳入原因。

  2. 确定可观察的功能接口(例如 HTTP 路由、界面、命令、事件等)。契约围绕此接口编写。

  3. 针对每个 Gherkin 场景和每项 TDD 验收标准,推导出相应案例:

    • 精确输入(路由、参数、格式);
    • 每个案例的精确输出(状态码、数据、可见文本、持久化效果);
    • 错误(哪种无效输入会产生哪种响应)。
  4. **确定不可协商的名称:**路由、字段、可见消息、格式。这些是 TESTER 会逐字核验的内容。

  5. 标注每一行的来源(Gherkin 场景、TDD 验收标准、ADR)。没有来源的行属于新决策:标记为 DECISIÓN PROPUESTA,并加入供人确认的问题列表。绝不能将其表述为 HU 中已有的内容。

  6. 声明哪些内容不在契约范围内(所有内部内容:结构、函数名称、查询)→ DEV 可自行决定。

  7. 使用 assets/contrato-template.md 保存到 contratos/CONTRATO-<HU>.md,版本为 v1。

  8. **停止。**向人类提交契约和问题。不要调用任何人。

版本管理

如果在周期中发现缺漏(由 TESTER、DEV 或裁决结果报告):

  1. 向人类提出问题;
  2. 收到答复后,编辑契约、升级版本(v2、v3……),并在变更日志中添加一行(变更内容、原因、批准人);
  3. LEAD 通知 TESTER 和 DEV 新版本的信息。

约束

  • 不得对 HU 未说明的内容自行假设:应当提问。
  • 不得在契约中描述内部实现。
  • 不得与既有契约中确定的名称冲突,除非明确说明。
  • 不得发布任何内容。

评论

支持 Markdown