AGENT SKILL
write-contract
暂无简介
- License 许可
- Apache-2.0
- 最近更新
- 2026-08-22
- Stars
- ★ 0
- Forks
- 0
03 SKILL.md 正文
Write or refine a contract
Use this skill when defining or restructuring externally observable module behavior.
- Read
docs/contracts/README.mdanddocs/contracts/evaluation/README.md. - Establish terminology/model before writing detailed requirements.
- Give an ID only to an independently assessable obligation and declare its
type as
behavioral,structural, orprocess. - Keep requirement type separate from evaluation method; do not classify a requirement by whether it happens to have a unit test.
- Split clauses that can be violated independently. Do not strengthen an established product statement into additional observable guarantees merely to make it easier to test.
- Move caller guidance, rationale, examples, and deliberate non-guarantees to application notes instead of inventing coverage obligations.
- Avoid duplicate summary requirements; cross-reference detailed elements.
- Create/update evaluation activities using
automated-test,inspection, oranalysisand state sufficient evidence without adding behavior. When an automated test is the correct method but the implementation/evidence is intentionally deferred, keep aMethod:line containingautomated-testand add theEvidence:valueplannedrather than substituting a manual method. - Only after contract + evaluation review, create/update tests and
@covers(...)declarations for automated-test evidence. - Keep Markdown navigation current: link each contract from
docs/contracts/README.mdand each evaluation document fromdocs/contracts/evaluation/README.mdusing repository-relative Markdown links. - Regenerate traceability and review
PLANNED-AUTOMATED,MANUAL-REVIEW, missing evaluation, missing automated evidence, and broad coverage claims.