agentleFS
wakqasahmedwakqasahmed/ai-engineering-workflow-skills/skills/engineering/define-done/SKILL.md

define-done

Skill2 starsChanged 2 months agoMITView on GitHub

Define acceptance criteria, risk level, and verification before editing. Use at the start of non-trivial implementation or when an issue lacks clear proof of completion.

3 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this before changing code or docs on non-trivial work.

    line 8
  2. Distinctive:

    Write testable acceptance criteria.

    line 13
  3. Very specific:

    Follow system-level/core.md (Test Database Safety) for what counts as disposable/dedicated storage and when a staging backup is required.

    line 26
  4. Distinctive:

    Write a test for at least one failure path (timeout, provider error, partial write), not only the happy path.

    line 34
  5. Distinctive:

    Verify state transitions are correct under retry: a record re-attempted after a partial failure must not silently double-count, skip, or …

    line 35

“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “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

Define Done

Use this before changing code or docs on non-trivial work.

Workflow

  1. Classify risk: low, medium, or high.
  2. Write testable acceptance criteria.
  3. Name the minimum verification commands or manual checks.
  4. Record known constraints and non-goals.
  5. State rollback or recovery notes for medium/high-risk changes.

Risk Rules

  • Low: narrow copy, style, test-only, or isolated bug fix (with no business-rule change).
  • Medium: user-visible behavior, business logic, data handling, CI, integrations, or multi-file behavior.
  • High: auth, payments, permissions, secrets, migrations, deployment, infrastructure, tenant data, or irreversible operations.

Test Database Requirement

Follow system-level/core.md (Test Database Safety) for what counts as disposable/dedicated storage and when a staging backup is required. Verification commands named in step 3 of the workflow above must satisfy that rule before this skill is considered done.

Async/Stateful Contract Requirement

For medium/high-risk work that involves queue jobs, background workers, retries, or any record that tracks attempt/state transitions:

  • State the retry limit and what happens on exhaustion (fail loudly, dead-letter, alert) — don't leave it implicit.
  • Confirm the job or handler is idempotent on retry, or explicitly justify why it doesn't need to be.
  • Write a test for at least one failure path (timeout, provider error, partial write), not only the happy path.
  • Verify state transitions are correct under retry: a record re-attempted after a partial failure must not silently double-count, skip, or corrupt its tracked state.

Done Means

  • Acceptance criteria satisfied.
  • Relevant checks run and named.
  • Tests added/updated, or a reason is recorded.
  • Independent review completed for non-trivial work.
  • Rollout/rollback notes present when risk warrants them.

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.