Getting Started

Installation and quick start

Install StoryLoop, connect GitHub, and see your first pull request reviewed against its acceptance criteria.

Installation

  1. 1

    Find StoryLoop on the Atlassian Marketplace and click Try it free. StoryLoop works with Jira Cloud.

  2. 2

    Grant the requested permissions. StoryLoop needs to read and write Jira issue data, and to call the GitHub API.

  3. 3

    Open any issue: the Acceptance Criteria panel appears below the description.

Open StoryLoop on the Atlassian Marketplace ↗

Quick start

From installation to your first ticked-off acceptance criterion in five steps.

  1. 1

    Connect GitHub. Add a personal access token and connect your repositories (see GitHub integration).

  2. 2

    Generate criteria. Open an issue with a description and click Generate in the Acceptance Criteria panel. Review the criteria and click Accept & Save.

The Review Acceptance Criteria dialog with generated criteria, an Edit button, Discard and Accept & Save
Generated criteria open in a preview. Edit them or click Accept & Save; nothing is saved before that.
  1. 3

    Open a pull request whose title, branch name or description contains the issue key, for example PROJ-123.

  2. 4

    Get the review. Within a minute or two, StoryLoop posts a review and a StoryLoop check on the pull request, and shows in Jira which criteria it meets.

A StoryLoop review comment on a GitHub pull request with a table of criteria, status and evidence
The StoryLoop review on the pull request: each criterion with its status and a link to the code that implements it.
  1. 5

    Merge the pull request. The criteria it met become Done.

The Acceptance Criteria panel showing 5 of 5 done, each criterion marked Merged with a link to the pull request
After the merge: every criterion the pull request met is Done and linked to it.

Project settings

Project administrators find StoryLoop under Project settings → Apps → StoryLoop, or by clicking the gear icon in the Acceptance Criteria panel. There are three tabs: