Skip to content

Instantly share code, notes, and snippets.

@jeremyckahn

jeremyckahn/ticket-templates.md

Last active February 4, 2022 00:07
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jeremyckahn/d3ddf1344c028d752efb24de4f3c4d0f to your computer and use it in GitHub Desktop.
Save jeremyckahn/d3ddf1344c028d752efb24de4f3c4d0f to your computer and use it in GitHub Desktop.
Download ZIP
Raw
ticket-templates.md

User Story/Task

Description

A high-level explanation of the singular feature that is needed.

Background

Any context that might help an uninitiated person understand why this feature is needed.

Acceptance criteria

Any and all specific details that would qualify this ticket as being complete. These criteria should be as minimally scoped as practical.

  1. Acceptance criterion
  2. Acceptance criterion
  3. etc.

Notes and relevant links

Any additional background information that might help the implementor.

Any links to information that would provide context and clarity. For example:

  • Related ticket links
  • Source code links (prefer line-level deeplinks)
  • Documentation links

Bug Report

Description

A high-level explanation of the defect.

Expected Behavior

Any and all specific details that would qualify this issue as being resolved.

  1. Expected behavior
  2. Expected behavior
  3. etc.

Steps to reproduce issue

  1. Perform action
  2. Observe behavior or lack thereof

Notes and relevant links

Any additional background information that might help the implementor of the fix.

Any links to information that would provide context and clarity. For example:

  • Screenshots (annotated if appropriate)
  • Deeplinks to logs
  • Related ticket links
  • Source code links (prefer line-level permalinks)
  • Documentation deeplinks
  • Person or role that discovered the issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment