Definition of Done Checklist for Jira
Write your team’s Definition of Done once. Every new work item gets it as a checklist, each checked item shows when it was checked, and Jira can refuse to move a work item to Done until the list is complete.
Set up (space admin, 2 minutes)
- Install the app from the Atlassian Marketplace (a Jira admin does this once for the site).
- In your space, open Space settings → Apps → Definition of Done. (On older Jira screens this is Project settings.)
- Type the checklist items, one per line, up to 30. For example:
Code reviewed by another developer Unit tests added and passing Acceptance criteria met Documentation updated
- Choose the work types that should get the checklist, for example Story and Bug. Leave all unchecked to use it for every work type except subtasks. Subtasks get the checklist only if you select their type.
- Click Save.
From now on, every new work item of those types gets the checklist when it is created. A work item that existed before gets it the first time someone opens the Definition of Done section on it. Changing the list later does not change checklists that work items already have.
Block “Done” until the checklist is complete (optional)
This works in company-managed and team-managed spaces. You need permission to edit the workflow.
- Open the workflow editor:
- company-managed space: Space settings → Workflows, then edit the workflow;
- team-managed space: Space settings → Work types, open any work type, then Edit workflow.
- Select the transition into Done.
- Next to Validate details, add a rule and choose Definition of Done is complete (listed under the app’s name, Definition of Done Checklist).
- Click Update workflow. In a team-managed space, Jira asks which work types the workflow applies to; keep them selected and save.
Now, if someone tries to move a work item to Done while its checklist has unchecked items, Jira stops the move and shows: “Complete the Definition of Done checklist before moving this work item.” Work items without a checklist (for example, a work type you did not select) can move as usual.
Use the checklist (everyone on the team)
- Open a work item. The Definition of Done section is in the details column; click it to expand.
- Check items as you finish them. Under each checked item you see the date it was checked.
- Add an item that only this work item needs, or remove one that does not apply. This changes only this work item, not the team’s list.
- A progress line shows “3 of 4 done”, and a green Done label appears when everything is checked.
Anyone who can edit the work item can check, add and remove items. People who can only view it can see the checklist but cannot change it.
Find work items with JQL
The app makes two fields searchable in Jira’s advanced search:
| Field | Meaning |
|---|---|
dodOpen | number of unchecked items on the work item |
dodTotal | number of items on the work item |
Examples:
dodOpen > 0 AND statusCategory = Done project = KEY AND dodOpen > 0 dodTotal > 0 AND dodOpen = 0
The first query finds work items that reached Done with unchecked items, for example ones closed before you added the workflow rule. Work items without a checklist do not match these queries.
Good to know
- Up to 30 items per checklist and 200 characters per item; longer text is shortened. Duplicate lines in the team’s list are saved once.
- Only space admins (and Jira admins) can change the team’s list.
- If two people change the same checklist at the same moment, the change saved last wins. Reload the work item to see the latest state.
- The checklist and the workflow rule work in company-managed and team-managed spaces.
Where your data is stored
The app runs on Atlassian Forge and has no servers of its own. Each work item’s checklist is saved in your Jira site as a work item property named lamplit-dod, and the team’s list as a space property named lamplit-dod-template. Details are in the privacy policy.
Uninstall
Before you uninstall, remove the rule Definition of Done is complete from every workflow that uses it. If the app is gone and the rule is still there, Jira refuses every move into Done with the message that it couldn’t find the validator.
Then a Jira admin can uninstall the app in Jira settings → Apps → Manage apps. Checklists already saved stay in your Jira site as work item properties and are no longer shown, and the dodOpen and dodTotal searches stop working. A Jira admin can delete the saved properties through the Jira REST API; we can send you a short script on request.
Help
Questions, bugs or ideas: see Support.