Standard Bug Write-Up Format

Owned by Cate Boerema (Deactivated)
Last updated: Feb 17, 2021 by Julian LadischVersion comment
1 min read

See also FOLIO Communication Spaces – Guidelines for Issues - Bugs and Tasks


To ensure bugs filed are understandable and testable, please use the following format.

Overview: Optional high-level description of problem

Steps to Reproduce:

  1. Log into some FOLIO environment as User X
  2. Click this
  3. Select that
  4. etc.

Expected Results: What I expected to see happen

Actual Results: What actually happened

Additional Information:

  • I copy and paste the complete URL into the description. This makes it much easier for the folks who replicate, triage, analyze and fix the issue.
  • Optional: I take a screenshot that shows the issue (should contain the URL unless pasted into the issue description). It may help to mark the issue in the screenshot.
  • Anything else I noticed or tested that might be relevant to this issue

Interested Parties: Notify relevant people of this bug by @-mentioning them (type @ then search for their name).


Preformatted template for pasting into Jira

*Overview:*
*Steps to Reproduce:*
# Log into some FOLIO environment as User X
# Click this
*Expected Results:*  
*Actual Results:*   
*Additional Information:*
URL: 
*Interested parties:*