1. Open and configure the policy
- Install the app in a supported Jira Cloud site through its Marketplace listing.
- Open Issue Readiness Guard from Jira administration.
- Set minimum summary and description lengths.
- Review required description headings for bug, story, and task-style issues.
- Choose whether an assignee is required, save the policy, and run an on-demand scan.
The starting policy uses 12 summary characters, 80 description characters, bug headings for steps to reproduce, expected behavior, and actual behavior, an acceptance-criteria heading for stories, and an outcome heading for tasks. Administrators can adjust these rules.
2. Understand readiness results
An issue passes only when every rule applicable to its issue type passes. The score is the percentage of applicable checks passed. The report shows ready and not-ready counts, readiness percentage when at least one issue was evaluated, score bands, truncation state, and bounded issue references with missing rule codes.
3. Use the issue panel
Open an individual issue and expand the Issue Readiness Guard panel to evaluate that issue against the current policy. The panel is informational; it does not change the issue, workflow, fields, or assignee.
4. Manual and scheduled scans
A Jira administrator can start an on-demand scan. A licensed installation also runs one daily scheduled scan. Each run stops at 5,000 active issues and retains only the latest report. At most 250 not-ready issue references are stored; larger result sets are marked truncated.
5. Permissions and data
- read:jira-work reads the issue ID and key, summary, description, issue type, and assignee account-ID presence needed to evaluate the configured rules.
- storage:app stores the current policy and latest bounded report in Forge app storage.
Stored findings contain issue ID, issue key, issue type, score, and missing-rule codes. They exclude summary text, description text, and assignee identity details. The app declares no Jira write scope, remote backend, or external egress.
6. Delete the latest report
Use Delete stored report on the admin page to remove the latest readiness report. The current policy remains until changed or the installation data is handled through Atlassian’s app lifecycle.
7. Troubleshooting
An issue type uses unexpected headings
Issue types containing “bug” or “defect” use the bug rules; those containing “story” or “requirement” use story rules; other types use task rules.
A heading is not detected
Use an actual heading node in the Jira description. Matching ignores surrounding whitespace, letter case, and a trailing colon, but does not treat ordinary body text as a heading.
Readiness percentage is unavailable
An empty scanned population is reported as unavailable rather than zero. Confirm the site has active issues visible to the app.
8. Support
Email contact@craigtechservices.com with the app name, approximate time, expected behavior, observed behavior, and reproduction steps. Do not send passwords, API tokens, or unnecessary issue content.