Getting started

Install it

Find Issue Checker for Jira on the Atlassian Marketplace and install it on your Jira site. A Jira administrator installs it once for the whole site.

Open it inside a project

Open any project and choose Issue Checker from the project's menu (if the row of tabs is full, it is under More). Jira tells the app which project it was opened from, so the checks run straight away.

Or put it on a dashboard

Add the Issue Checker for Jira gadget to a dashboard, then choose the project from the Project dropdown in the gadget's header. A new gadget starts with no project chosen, and nothing is read until you pick one.

Or open it as an app

Open Issue Checker from Jira's Apps menu, on a page of its own.

Choose the project

Issue Checker checks one project at a time. Where you choose it depends on where you opened it:

• Inside a project, there is nothing to choose: it checks the project you opened it from. To check another project, open Issue Checker from that project.
• On a dashboard, the gadget asks in its own header: a dropdown labelled Project, on the line under the name. Pick a project and the checks run again straight away. The choice of sprints under What to include starts again from every sprint, because the new project has sprints of its own.
• As an app, choose the project from the Project dropdown at the top of the page. It opens with no project chosen every time. Pick another project there whenever you want to check it.

Set it up the way your team works

Open the settings from the gear (⚙) at the right of the name, on a dashboard gadget or the app's own page - even before a project is chosen. The page inside a project has no settings of its own: it uses the choices you last saved for that project. In the settings:

• Which checks run. Every check is listed under its group with a tick. Untick the ones that do not fit how your team works, and they leave the list and every count.
• The order. Drag a check by its handle (⋮⋮) to move it within its group, or choose Most found first under How it reads.
• What your columns mean. Only where Jira has a column wrong, say whether it is Not started, In progress, Waiting on something or Finished. Your word wins over Jira's, and every check reads it.
• What to include. Tick the sprints to check; left alone, every sprint is checked. Include backlog adds everything not in a sprint.
• Your own checks. Give a check a name and a Jira filter, press Test to see whether Jira accepts it and how many issues match, then Add check.

Read the headline

The top line says how many issues need attention and how many checks found something. Every check is listed underneath; a green zero means it ran and found nothing.

Open a check

Click a row to see the issues behind its count, each with a note saying why it was found. Click a key to open the issue in Jira and fix it there.

Keep the list short

Tick Show only found issues to hide the checks that found nothing. Dismiss a finding you have decided to live with; it waits in the Dismissed list until you restore it.