User guide

Installation and setup of the plugin is done in four easy steps, that gives you the flexibility to work with acceptance criteria in the way you need for your project.

Installation

To install the plugin, simply navigate to the plugin front-page at Jira Marketplace by using this Link and follow the installation instructions - we always offer a one-month free trial!

Create a new issue-type and transition for acceptance criteria

If you intend using the plugin for Acceptance criteria specifically (can be used for any sub-issue and use case), you need to create a new issue-type for acceptance criteria. This new type will hold the criteria themselves, each criteria in a unique issue.

To add a new issue type, follow these steps

Besides the new issue-type, we need a status for indicating that an acceptance criteria has been canceled or closed. If you already have a workflow with a canceled status, you can skip this next step.

Otherwise, follow the steps below to add a Canceled status and associated transition rule:

 

Now we’re all set-up to do the configuration of the plugin!

Configuring the plugin

Configuring the plugin is done through 6 simple steps within the configuration page. The configuration page is accessed from the “apps” → “manage apps” menu.

A detailed descriptions is shown on the left-hand side and depicting below:

Description

Configuration step

Description

Configuration step

The plugin will show a new panel in the overview of selected issue-types. When using the plugin for acceptance criteria, this will usually be necessary to display the panel on all issue-types that encapsulate Stories. A default Jira installation has Story and Task issue-types, which are obvious choices.

Search and select the issue-type(s) you want to display the new panel on. You can always change this and all other configuration later on.

If you create a new issue-type while having the configuration page open, then you need to do a manual refresh of the page in order to display it

 

In this step you select the issue-type that encapsulates the acceptance criteria. Every single criteria will have an instance of this object, and these instances are added, edited and closed directly from the editable table overview.

If you don't have an existing issue-type for acceptance criteria you can follow the steps prior in this guide to create one

 

In this step you select the Jira project, you want to issues to be created in. If you have numerous projects associated to your installation, this lets you select where the issues are created.

TIP: If you want a cool issue id for acceptance criteria such as AC-1234, then you can create a new project with these initials and use this

 

Stories and Acceptance Criteria are linked using any of the default, or custom created link-types you wish to use. Each story will have zero-to-many linked acceptance criteria.

A default Jira installation comes with the Relates link-type. This is a fine candidate. Alternatively, a new custom link-type can be created for linking the issues together.

 

Individual acceptance criteria can be removed directly from the table view. Removing a criteria will result in a transition and state change. Such a transition will typically be possible from any state and result in a status change resulting in Canceled.

If you don't have an existing transition and status defined for acceptance criteria, then you can follow the steps prior in this guide to create these

 

A really cool feature of this plugin, is that you can add custom fields from the acceptance criteria and make them editable directly within the table.

This feature is especially useful for things such as:

  • Displaying whether a criteria is automatically tested?

  • Displaying the current status of the implementation of this criteria

We currently only support a subset of the data-types within Jira, but are expanding the supported types continuously. If your custom field isn’t displayed, it is because it ISN’T supported yet. As a workaround, you can try another, more simple, datatype.

 

And that’s it! You are now ready to use the plugin. Navigate to an issue you choose in step 1 and see the end result.

Using the plugin

Using the plugin is trivial, the picture below shows some the main features so you dont miss out of anything:

Have any problems? Write us directly as support@bettercode.tech !