How To Write a Bug

How To Write a Bug

This wiki explains how to write a bug.

Open a New Issue

1. Select Bug Report Template

This will take you to a preformatted template to fill out.

a. Describe the Bug

• Clearly state what the bug is, who it affects, and how.
• Optionally, include the user’s goal or what they were trying to achieve.

b. Steps to Reproduce

• List step-by-step actions that lead to the bug (ie., navigate, click, scroll).
• Ensure it's easy for someone else to replicate the issue.

c. Actual Result

• Describe what currently happens when the bug occurs.
• Use screenshots if helpful and include them.

d. Expected Result

• State what should have happened instead of the bug.

e. Device Configuration

• Fill in device name, OS version, browser, and browser version where the bug was observed.

f. Action Items

• Check off the boxes as each step is completed in the bug resolution process.

g. Resources

• Add appropriate links to Staging and Release Decks.

h. Click Create

i. Labeling

• Add appropriate labels that include (but are not limited to) role, feature, bug, dependency, level, deck, and size.
• Add milestone and placement on the TDM: project board.