agentleFS
peterbamuhigirepeterbamuhigire/chwezi-dev-engine/skills/architecture/validation-contract/SKILL.md

validation-contract

Skill31 starsChanged 18 days agoMITView on GitHub

Use when authoring or normalising a specialist skill, or preparing to ship a feature or release — defines the seven evidence categories every specialist skill must declare against and provides the canonical Release Evidence Bundle template. The contract spine that turns scattered validation skills into a coherent ship-readiness check.

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Every specialist skill that produces validation evidence declares at least one evidence category with a concrete artifact reference.

    line 43
  2. Distinctive:

    When a skill straddles the line, the default is declare.

    line 129
  3. Distinctive:

    When a feature or release is ready to ship, the reviewer produces a single fillable document — the Release Evidence Bundle — that links to …

    line 133
  4. Distinctive:

    Read and search are required to trace evidence producers and consumers.

    line 175

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Validation Contract

Acknowledgement: Shared by Peter Bamuhigire, techguypeter.com, +256 784 464178.

<!-- dual-compat-start -->

Use When

  • Authoring a new specialist skill and deciding which validation evidence it should produce.
  • Normalising an older specialist skill against the current house style.
  • Preparing a feature or release for ship and assembling the Release Evidence Bundle.
  • Reviewing a PR that claims a feature is production-ready.

Do Not Use When

  • The work is purely local, experimental, or explicitly throwaway with no path to production.
  • The skill being authored is a baseline, process, or pure index skill. Those do not declare evidence.
  • The task is unrelated to validation planning or shipping readiness.

Required Inputs

  • The specialist skill or feature being validated, including its intended scope and risk tier.
  • Access to the repository's existing validation skills (advanced-testing-strategy, vibe-security-skill, observability-monitoring, etc.) as the source of category-specific "how to validate" content.
  • Awareness of the 14 canonical artifact templates in skill-composition-standards/references/ so evidence rows can cite existing formats.

Workflow

  • Identify whether the skill or feature in scope is specialist (declares evidence) or baseline/process (does not).
  • For specialist skills: map each artifact the skill produces to one of the seven evidence categories.
  • For releases: produce a Release Evidence Bundle that links concrete artifacts under each of the seven categories, using N/A — <reason> only where an entire category legitimately does not apply.
  • Cross-check risk tier guidance before permitting any N/A in high-risk releases.

Quality Standards

  • Every specialist skill that produces validation evidence declares at least one evidence category with a concrete artifact reference.
  • Evidence declarations cite existing artifact templates where possible instead of inventing new formats.
  • Release Evidence Bundles never carry empty cells. Every cell links evidence or carries an N/A — <reason> line.

Anti-Patterns

  • Declaring every category on every skill "just in case". This kills the signal.
  • Writing prose validation notes instead of linking concrete artifacts in a Release Evidence Bundle.
  • Permitting unjustified N/A on Correctness, Security, Data safety, Operability, or Release evidence in high-risk releases.
  • Treating the Release Evidence Bundle as a retrospective summary written after ship. It is produced before ship.

Outputs

  • A specialist skill with a validated ## Evidence Produced section declaring one or more of the seven categories.
  • A Release Evidence Bundle in the project's docs/ tree linking evidence for every applicable category at ship time.
  • Clear N/A — <reason> annotations for non-applicable categories, with risk-tier-aware justification.

References

  • references/evidence-categories.md: per-category definition, indicative contributing skills, and common artifact shapes.
  • references/declaration-form.md: the ## Evidence Produced table form, rules, and worked examples.
  • references/release-evidence-bundle-template.md: the canonical fillable Release Evidence Bundle.
  • references/integration-rollout.md: audit trail of edits made to other skills during this skill's rollout.
<!-- dual-compat-end -->

The three repository-wide contracts

The repository is held together by three contracts, each codified in a baseline skill:

  1. House-style contract — every skill follows the same shape. Source: skill-composition-standards, Standard 1.
  2. Inputs/Outputs contract — every skill declares the artifacts it consumes and produces. Source: skill-composition-standards, Standard 2.
  3. Evidence contract — every specialist skill declares which of seven fixed validation categories its artifacts contribute to, and every release produces a Release Evidence Bundle. Source: this skill.

The three contracts stack. A skill that meets Standard 1 but skips Standard 2 or 3 is not repository-grade.

The seven evidence categories

#CategoryWhat the evidence proves
1CorrectnessBehaviour matches spec; tests cover risk surface; contracts hold.
2SecurityThreat model exists; scans clean; secrets handled; auth/authorisation verified.
3Data safetySchema integrity; migration safety; backup, retention, and PII handling.
4PerformanceBudgets met; load profile understood; query plans acceptable.
5OperabilitySLOs defined; runbook exists; observability wired; rollback plan ready.
6UX qualityAccessibility pass; design audit; content/UX-writing review; AI slop check.
7Release evidenceChange record; migration plan; rollout/rollback log; post-deploy verification.

The taxonomy is closed. Adding an eighth category requires editing this skill, not silently extending it elsewhere. Full definitions and indicative contributing skills live in references/evidence-categories.md.

Declaration mechanic

Specialist skills add a ## Evidence Produced section to their SKILL.md, between ## Outputs and ## References:

## Evidence Produced

| Category | Artifact | Format | Example |
|----------|----------|--------|---------|
| Security | Threat model | Markdown doc per `skill-composition-standards/references/threat-model-template.md` | `docs/security/threat-model-checkout.md` |
| Operability | Runbook | Markdown doc per `skill-composition-standards/references/runbook-template.md` | `docs/runbooks/payment-failures.md` |

Rules

  • A specialist skill that produces validation evidence MUST declare at least one row.
  • Each row's Category value MUST be one of the seven canonical names (case-sensitive).
  • Each row's Format field MUST reference an existing template or define its own format inline in the same SKILL.md.
  • A specialist skill MAY contribute to multiple categories.
  • Baseline skills, process skills, and pure index/orchestration skills MUST NOT declare.

Worked examples live in references/declaration-form.md.

Specialist vs exempt skills

A skill is "specialist" for the purposes of this contract when it:

  • Produces concrete project artifacts (code patterns, schemas, configs, documents).
  • Is loaded for a specific domain or platform problem rather than as a baseline frame.

Skills exempt from declaring (non-exhaustive):

  • world-class-engineering, skill-composition-standards, validation-contract itself.
  • system-architecture-design, world-class-engineering, git-collaboration-workflow.
  • feature-planning, and spec authoring in project-requirements (../../sdlc-meta/project-requirements/references/spec-architect.md).
  • All superpowers:* skills.

When a skill straddles the line, the default is declare. False positives are cheaper than silent omissions.

The Release Evidence Bundle

When a feature or release is ready to ship, the reviewer produces a single fillable document — the Release Evidence Bundle — that links to the concrete artifacts satisfying each of the seven categories.

  • Template: references/release-evidence-bundle-template.md.
  • N/A semantics: permitted only with a reason on the same line. An empty cell is not acceptable.
  • Risk tier guidance:
    • Low risk — internal tools, docs, non-user-facing scripts. Typical bundle has 3-4 categories live.
    • Medium risk — user-facing feature, single-tenant. All 7 categories addressed; some may be N/A with reason.
    • High risk — multi-tenant data, payments, auth, external APIs, AI features. All 7 categories live; no N/A permitted on Correctness, Security, Data safety, Operability, or Release evidence.

Strictness

  • The contract uses MUST, MAY, MUST NOT in the RFC 2119 sense.
  • Mechanical enforcement is out of scope for this skill. It lands separately as a CI contract-gate hook that will:
    • parse ## Evidence Produced tables and warn on missing or invalid categories.
    • parse Release Evidence Bundles and warn on empty cells or unjustified N/A.
  • Authoring with binding language now means the CI hook is a parser and CI integration only, not a policy debate.

Integration with existing skills

The rollout in references/integration-rollout.md lists every edit made to other skills when this skill was introduced. Future edits that touch this contract should update that file.

Companion Skills

Risk-scaled simplification gate

Short code or fewer dependencies is not an acceptance criterion by itself. For high-risk changes, the Release Evidence Bundle must identify negative or mutation evidence that would fail if authorisation, boundary validation, transaction integrity, retry/idempotency, recovery, audit logging, accessibility state, or observability were removed. Low-risk read-only changes may use a smaller sufficient set when the record names the excluded categories and why they do not apply. This is a risk-scaled rule, not a universal one-test limit.

Inputs

ArtefactRequired?Purpose
Claimed release evidenceyesEstablish what can be verified
Category requirementsyesDetermine mandatory proof

Capability contract

Read and search are required to trace evidence producers and consumers. Execution is required only for machine-verifiable gates. Editing is permitted only when contract repair is authorised.

Degraded mode

Fallback when evidence cannot be executed or retrieved: mark the category unverified; never convert missing evidence into a pass.

Decision rules

Evidence stateRelease statusAction
Required category has verified passing evidencePass categoryAttach artefact to bundle
Evidence exists but is stale or incompleteConditionalRefresh before release
Required evidence is missing or failingBlockDo not ship

Domain anti-patterns

  • Accepting a prose claim as test evidence. Fix: require the named artefact or command result.
  • Reusing stale evidence after relevant code changed. Fix: rerun the producing check.
  • Marking inaccessible evidence as passed. Fix: record unverified.
  • Allowing one category to substitute for another. Fix: satisfy each mandatory category independently.
  • Shipping an incomplete evidence bundle. Fix: block until required artefacts and provenance are present.

Companion skills

  • skill-composition-standards — Standards 1 and 2. Load this before validation-contract.
  • world-class-engineering — repository production-readiness bar. This contract makes the evidence of meeting that bar a first-class artifact.
  • Category-specific skills — the source of truth for how to validate within each category (see references/evidence-categories.md).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.