How To Write a Bug - hackforla/tdm-calculator GitHub Wiki

This wiki explains how to write a bug.

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

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

• 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.

• Describe what currently happens when the bug occurs.

• Use screenshots if helpful and include them.

  Example: Screenshot

  

• State what should have happened instead of the bug.

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

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

  Example: Action Items being checked off

  

• Add appropriate links to Staging and Release Decks.

• Add appropriate labels that include (but are not limited to) role, feature, bug, dependency, level, deck, and size.

• Add milestone and project placement status on the TDM: project board.

  Example: Labeling