Best Practices for Effective Bug Reporting
When submitting a bug report, it is essential to provide accurate and detailed information to ensure the clarity of the bug being reported. This document serves as a guide to help you submit well-defined bugs. By following these guidelines, you can facilitate smoother and more efficient change management processes.
Steps to Reproduce Problem
These are the recipe steps that can be used to demonstrate the problem.
A numbered list is often helpful. Be specific here so that someone who is unfamiliar with the issue can easily reproduce the problem.
Also, make sure to describe any additional / relevant environmental conditions that might contribute to the bug (“web browser is Chrome/FireFox“, “occurs on my iPad 8th generation iOS 16.4.1“).
If you can send us a screen recording that is the best!
Examples:
Repro Steps:
Access https://sheds.idearoominc.com/ from my MacBook Pro 2019 iOS 16.4.1 on Safari
Select Side Utility under my Utility Category
Change Siding to T1-11
Add a Lean-To Porch
Current Behavior
Describes what the current undesirable behavior is. This is the bug.
Don’t leave this up to chance. Sometimes it isn’t obvious to the fixer or reviewer what is wrong.
Examples:
Current Behavior:
Select Side Utility under my Utility Category
Change Siding to T1-11
Add a Lean-To Porch
The building doesn’t change and I am no longer able to select other building styles
Expected Behavior
Describes the desired behavior that is different that the current behavior. This is how the product should behave once the bug is fixed.
Examples:
Severity
Give some assessment of the severity of the bug. This will help developer, fixers and reviewers prioritize the work to fix your defect.
Severity Levels & Definitions:
High: My Site is Down (please verify that nothing has changed on your DNS Records)
Medium: Impacts my day to day usage of my tool
Low: More of an annoyance but I can still get leads out the door