1. Introduction
Definition of Done & Ready for Jira turns your team's "done" and "ready" agreements from a wiki page nobody checks into criteria that are visible, scored, and enforced on every Jira issue. Reusable checklists live right on the issue with a live 0–100 readiness score, and workflow gates block a transition until every mandatory item is met — including in team-managed projects, where Jira offers no native validator.
The app ships with ready-made Definition of Ready, Definition of Done, Acceptance Criteria, QA, and Security Review templates, applies them to new issues automatically, and rolls compliance up into a portfolio report with one-click CSV export. It is built on Atlassian Forge with zero data egress: nothing ever leaves Atlassian.
2. Getting started
2.1 Installation
- Install Definition of Done & Ready for Jira from the Atlassian Marketplace.
- Grant the requested permissions when prompted. The app is built on Atlassian Forge and runs entirely on Atlassian infrastructure.
- Open any issue — the Definition of Done panel appears in the issue view. Add the starter templates from the admin page (see section 4) and you are ready to go.
2.2 Entry points
- Issue panel
- The Definition of Done context panel on every issue — checklists, statuses, the readiness score, and history. See section 3.
- Admin page
Jira Settings → Apps → Definition of Done— manage templates and configure gate enforcement. Jira admin permission required.- Compliance report
- A global page under
Appsin the Jira navigation — readiness and gate status across every tracked issue. See section 7. - Workflow validators
- Two validators — Definition of Done gate and Definition of Ready gate — you attach to workflow transitions. See section 5.
2.3 Requirements
- Jira Cloud — the app is a Forge app and supports Jira Cloud only.
- Any project type — the checklists work everywhere; the workflow gates work in both team-managed and company-managed projects.
3. The issue checklist panel
3.1 Readiness score & gate status
The panel header shows the issue's readiness score (0–100, see section 6) next to a gate badge: All criteria met when every mandatory item is complete, or N mandatory item(s) left when a gate would still block. The badge counts mandatory items across every checklist on the issue; the Done gate enforces all of them except Definition of Ready items, which belong to the Ready gate (section 5).
3.2 Adding a checklist
Use Add a checklist to apply any template to the issue — the picker lists each template with its kind (DoR, DoD, AC, QA, security). An issue can carry several checklists at once, each rendered as its own card with a progress bar and a done/total counter. Templates flagged for auto-apply attach themselves to new issues without any manual step.
3.3 Item statuses
Every item has five possible statuses:
| Status | Meaning |
|---|---|
| Open | Not started — the default. |
| In progress | Someone is actively working on it. |
| Done | Complete — check the box. |
| Skipped | Deliberately not done for this issue. Requires a reason. |
| N/A | Does not apply to this issue. Requires a reason. |
Check the box to mark an item done, or use the … menu for Mark in progress, Skip…, Mark N/A…, and Reopen. Skipping or marking N/A always prompts for a reason, which is shown under the item and recorded in the history — conscious exceptions, not silent ones.
3.4 Required items
Items marked Required carry a badge and drive the gate: a transition guarded by a gate passes only when every required item is Done, Skipped, or N/A. Optional items influence the readiness score but never block.
3.5 Suggested acceptance criteria
Suggest AC derives acceptance-criteria suggestions from the issue's own summary and description — deterministically, on-platform, with zero egress. No large language model is involved and nothing leaves Atlassian. Pick the suggestions you want and they are added as a checklist on the issue.
3.6 History
History opens the issue's audit trail: every checklist applied or removed, every status change with who did it and when, and every skip/N-A reason. The log is bounded per issue (newest 200 entries) and is the basis of the app's auditability.
4. Templates
4.1 The five starter templates
From the admin page, Add built-in starter templates seeds five ready-made checklists so there is no blank-page setup:
| Template | Kind | Example items |
|---|---|---|
| Definition of Ready | DoR | Story follows the "As a… I want… so that…" format; acceptance criteria defined and testable; estimated by the team; dependencies identified and unblocked. |
| Definition of Done | DoD | Code peer-reviewed and merged; unit and integration tests passing; acceptance criteria verified; no open critical bugs; verified in staging. |
| Acceptance Criteria | AC | Given / When / Then scenarios documented; edge cases covered. |
| QA Checklist | QA | Happy-path manual test passed; regression suite green. |
| Security Review | security | Input validation reviewed; authN/authZ checks in place; no secrets committed. |
Every starter item is editable — treat them as a starting point, not a prescription.
4.3 Scoping
- All projects (global)
- The template is available and auto-applies everywhere.
- A specific project
- Limited to one project — useful for team-specific standards.
- A specific issue type
- For example, a Security Review checklist only on Story issues.
- Project + issue type
- The narrowest scope — one issue type in one project.
4.4 Auto-apply
Toggle Auto-apply to matching new issues on a template and every newly created issue that matches its scope receives the checklist automatically. Auto-apply is idempotent per template — an issue never receives the same checklist twice.
5. Workflow gates
5.1 Adding a gate to a workflow (one-time setup)
What you are about to do, in plain words: a workflow is the path an issue travels in Jira (for example To Do → In Progress → Done), and a transition is one hop on that path. Right now, anyone can drag an issue to Done even with required checklist items still open. In the steps below you will add the app's Definition of Done gate as a rule on the hop into Done, so Jira checks the checklist first and politely refuses when required items are unfinished. It takes about two minutes, once, per project workflow.
Before you start — two things to check:
- You need admin rights: project admin is enough for a team-managed project; company-managed workflows need a Jira admin.
- Find out which project type you have: look at the bottom of your project's left sidebar. If it says "You're in a team-managed project", follow the first list below. If it doesn't, yours is company-managed — follow the second list.
If your project is team-managed (most newer projects are):
- Open your project, then click
Project settingsat the bottom of the left sidebar. - In the settings menu, open the work type you want to guard — for example
Task. (Jira may call these "work types" or "issue types".) - Click the
Edit workflowbutton at the top right. A diagram opens showing your statuses as boxes: To Do, In Progress, Done. - Click on the small chip or arrow attached to the Done box (it is usually labelled Any or with the transition's name). A panel opens on the right titled Transition.
- In that panel, under Rules, click the
+next to Validate details (it says "Validate details before moving the issue"). - A rule picker opens. Choose Definition of Done gate — you will find it at the top, or under Marketplace rules. Click
Select. - The rule needs no configuration — just click
Add. - Now click the blue
Update workflowbutton at the very top right, and confirm withSavein the dialog. (The dialog lists every work type sharing this workflow — that is fine, keep them selected.)
If your project is company-managed:
- Click the
⚙gear icon in the top-right of Jira, thenIssues. - In the left menu choose
Workflows, find the workflow your project uses, and clickEdit. - Click the transition arrow that points into Done.
- Open the
Validatorstab and clickAdd validator. - Choose Definition of Done gate from the list and confirm.
- Click
Publish(orPublish draft) to make the change live.
Check it worked:
- In the workflow diagram, the transition into Done now shows a small rule marker (a ⚡ on the chip in team-managed projects).
- Open any issue that has a checklist with an unfinished Required item and try to move it to Done. Jira should refuse with a message like:
Definition of Done not met — 1 mandatory item remaining: … - Tick the remaining required items and try again — now the issue moves.
Which checklists does each gate check? The Done gate enforces the required items of every checklist type except Definition of Ready — DoD, Acceptance Criteria, QA, Security, and custom checklists alike. The Ready gate enforces Definition of Ready checklists only: add it with the same recipe on the transition out of To Do (or your sprint-start transition), picking Definition of Ready gate in step 6 instead.
5.2 Hard-block vs. warn-only
On the admin page, the Gate enforcement card has a Hard-block toggle. In hard-block mode the transition is refused until mandatory items are complete. In warn-only mode the gate is advisory: the transition is allowed, so teams can adopt the discipline gradually before turning enforcement on.
5.3 What a blocked transition looks like
When a gate blocks, Jira shows the standard validator error with the app's message, for example: Definition of Done not met — 2 mandatory item(s) remaining: Acceptance criteria verified; No open critical or blocker bugs. The panel's gate badge shows the same state before anyone attempts the transition, so blocks are never a surprise.
5.4 Fail-open design
If the gate cannot read an issue's checklist state (for example, a transient error), it allows the transition rather than trapping your team. A gate should enforce your working agreement — never lock you out of your own workflow.
6. Readiness scoring
Every issue with at least one checklist gets a live 0–100 readiness score. Mandatory items weigh twice as much as optional ones, and Skipped/N/A items count as resolved — the score reflects real completeness of the agreement, not raw checkbox counts. The score updates instantly as items change and is color-coded: green from 80, amber from 50, red below.
7. The compliance report
7.1 Reading the report
The global report (under Apps) aggregates every issue that carries a checklist:
- Issues tracked — how many issues have checklists.
- Avg readiness — the mean readiness score, color-coded.
- Gates met / Gates blocked — how many issues would pass or fail their gate right now.
- Checklists by kind — distribution across DoR, DoD, AC, QA, and security.
- Issues blocking on mandatory items — the worst-first list of issues with open mandatory items, each showing its score and how many items are left.
The report is capped for performance on very large sites; a footer note tells you when it is showing a subset.
7.2 CSV export
Export CSV downloads the full table — issue key, readiness, gate state, blocking-item count, checklist kinds, and item totals — ready for spreadsheets or BI tooling.
8. Privacy & security
- Zero egress. The app runs entirely on Atlassian Forge. There are no external servers, no outbound calls, and no data ever leaves Atlassian. It is eligible for the Runs on Atlassian program.
- Minimal permissions. Storage, read-only Jira access, and the Privacy API reporting scope — nothing else. All user-triggered reads run as the acting user, so Jira enforces each person's own permissions.
- Personal data. The audit trail stores the acting user's Atlassian account ID (never names or emails). A weekly Privacy API poll reports stored account IDs to Atlassian and scrubs those of closed accounts.
- Accessibility. WCAG AA contrast in both light and dark themes; the panel follows your Jira theme automatically.
Full details: Privacy Policy, Security Statement, and the Privacy & Security tab on the Marketplace listing.
9. Troubleshooting
- The panel does not appear on issues
- Confirm the app is installed on the site and you have permission to view the issue. The panel is an issue-context panel — look for Definition of Done in the issue's side panel area.
- The gate is not blocking anything
- A gate only acts on transitions it is attached to. Check the workflow editor for the Definition of Done gate / Definition of Ready gate validator on the transition, and confirm the admin toggle is on Hard-block (warn-only never blocks).
- The report shows no issues
- Only issues that carry at least one checklist are tracked. Apply a template to an issue (or enable auto-apply) and refresh.
- A template does not auto-apply
- Check the template's scope matches the issue's project and issue type, and that its auto-apply toggle is on. Auto-apply runs when an issue is created — it does not retroactively attach to existing issues.
10. FAQ
- Does it really work in team-managed projects?
- Yes — both gates declare support for team-managed and company-managed projects. This is the app's core differentiator: team-managed Jira has no native transition validator.
- Can one issue have several checklists?
- Yes. For example, a DoR, a DoD, and a Security Review can all live on the same issue; the gate evaluates the mandatory items of the matching kind.
- Who can edit templates?
- Template management lives on the Jira admin page, so it requires Jira admin permission. Anyone who can edit an issue can work its checklist.
- Where is my data stored?
- Exclusively in Atlassian Forge storage inside your own site. Data residency follows your Atlassian host site.
- Does the AC suggester send my issue text to an AI service?
- No. Suggestions are derived deterministically from the issue's own summary and description, on-platform, with zero egress.
11. Support
- Support portal: chefstackz.com/support
- Email: support@chefstackz.com
- Privacy Policy: chefstackz.com/privacy
- Terms of Use: chefstackz.com/terms
We typically respond within one business day.