Skip to content

Draft — not approved. A working draft by UASK. It may change without notice.

Definition of done

Used in the playbook Quality and release. Also used in Definition of Done

Download definition-of-done.md — the source, as in the repository.

How to use

The template's own instructions:

UASK Engineering Hub template · definition-of-done 0.2.0 · item process.definition-of-done · playbook quality.quality-release (R1) · CC BY 4.0 This is the copy form of the checklist `process.definition-of-done`, which is the one home of these lines; the number at the end of each line is its rule there (tests/check_repo.py checks that every rule appears). Copy to the project as DEFINITION-OF-DONE.md (or a section of CONTRIBUTING.md) and cut it down: keep only checks the project really performs, add lines of your own, remove none that applies at your tier. Change it only through a reviewed pull request. Delete these comments in the copy.

Fields

Front-matter fields and sections of the document the template creates. A section marked Optional in the template may be deleted from a copy; every other field and section stays (tools/check_artifacts.py checks this for the kinds it knows).

Field or sectionWhereRequired
Every packagesectionrequired
A change to stored data or a live systemsectionrequired
This project onlysectionrequired

Example

A filled-in copy for an invented product, templates/examples/definition-of-done.md, in the Hub repository.It shows the level of detail to aim for, not text to reuse.

example-definition-of-done.md
# Definition of Done — Fieldnotes
Version: 0.2.0 · Owner: Sam Roe · Last changed: 2026-03-01
A work package is done when every line below that applies to it is true. A line that does not apply is marked "n/a" in the pull request
with a reason. "Done" means verified: a commit hash and the output of the checks, otherwise the package is reported as "not verified".
## Every package
- [ ] The Done criterion of the brief is met and the evidence is in the pull request (test, command output, screenshot). (R1)
- [ ] The gate script is green locally and in CI, and it is the same script: `bash tests/run.sh`. (R2)
- [ ] The checks were seen to fail before the change and to pass after it; a fixed defect has a regression test. (R3)
- [ ] Verified by someone who did not build it (a person or a second session), who re-ran the checks; at the lightweight tier the builder checked it
against this list and said so. (R4)
- [ ] The files changed are those the brief allows; any other is explained. (R5)
- [ ] The pull request title and commits follow Conventional Commits; breaking changes are marked. (R6)
- [ ] Documentation is updated: user docs, README, and an ADR if an architectural decision was made; `CHANGELOG.md` has a line under `Unreleased`
if users will notice. (R7)
- [ ] No secrets, no debug leftovers, no new warnings; new dependencies have a compatible licence, are maintained and have no known exploited vulnerability. (R8)
- [ ] Anything that is the owner's to decide is listed under "Owner decisions needed", not merged as decided. (R9)
- [ ] The package's line is in the project log: id, branch, commit, verdict, time against the estimate. (R10)
## A change to stored data or a live system
- [ ] A backup proved by restore exists and is recorded with the change; the rollback was tried or its steps are listed. (R11)
## This project only
- [ ] The kill test (`tests/test_save_kill.py`) passes for every change to the note store. (R12)

Completion checks

A copy is complete when:

  • every required field and section above is present, in the same order, and no bracketed placeholder is left;
  • the template's comments are deleted from the copy;
  • the exit criteria of its stage of the playbook Quality and release are met;
  • the owner has approved it, where the playbook asks for approval. Only the owner sets approved.

Source

templates/definition-of-done.md, as in the repository. Placeholders are in square brackets; comments carry the instructions.

definition-of-done.md
<!--
UASK Engineering Hub template · definition-of-done 0.2.0 · item process.definition-of-done · playbook quality.quality-release (R1) · CC BY 4.0
This is the copy form of the checklist `process.definition-of-done`, which is the one home of these lines; the number at the end of each
line is its rule there (tests/check_repo.py checks that every rule appears). Copy to the project as DEFINITION-OF-DONE.md (or a section
of CONTRIBUTING.md) and cut it down: keep only checks the project really performs, add lines of your own, remove none that applies at
your tier. Change it only through a reviewed pull request. Delete these comments in the copy.
-->
# Definition of Done — [project]
Version: 0.2.0 · Owner: [name] · Last changed: [YYYY-MM-DD]
A work package is done when every line below that applies to it is true. A line that does not apply is marked "n/a" in the pull request
with a reason. "Done" means verified: a commit hash and the output of the checks, otherwise the package is reported as "not verified".
## Every package
- [ ] The Done criterion of the brief is met and the evidence is in the pull request (test, command output, screenshot). (R1)
- [ ] The gate script is green locally and in CI, and it is the same script: `<gate command, for example bash tests/run.sh>`. (R2)
- [ ] The checks were seen to fail before the change and to pass after it; a fixed defect has a regression test. (R3)
- [ ] Verified by someone who did not build it (a person or a second session), who re-ran the checks; at the lightweight tier the builder checked it
against this list and said so. (R4)
- [ ] The files changed are those the brief allows; any other is explained. (R5)
- [ ] The pull request title and commits follow Conventional Commits; breaking changes are marked. (R6)
- [ ] Documentation is updated: user docs, README, and an ADR if an architectural decision was made; `CHANGELOG.md` has a line under `Unreleased`
if users will notice. (R7)
- [ ] No secrets, no debug leftovers, no new warnings; new dependencies have a compatible licence, are maintained and have no known exploited vulnerability. (R8)
- [ ] Anything that is the owner's to decide is listed under "Owner decisions needed", not merged as decided. (R9)
- [ ] The package's line is in the project log: id, branch, commit, verdict, time against the estimate. (R10)
## A change to stored data or a live system
- [ ] A backup proved by restore exists and is recorded with the change; the rollback was tried or its steps are listed. (R11)
## This project only
<!-- Add the checks specific to the product, for example:
- accessibility check of changed pages;
- a database migration has a tested down step or a documented restore;
- translations updated for every changed string;
- tested on the oldest and newest supported host version. -->
- [ ] [project-specific check] (R12)