Bug report template

A bug report is a documented record detailing an issue encountered in a software application. It serves as a communication tool between users, testers, and developers, providing clear and concise information about the problem. The report typically includes a description of the bug, steps to reproduce it, expected versus actual results, and relevant technical details.

Effective bug reports are crucial for diagnosing and resolving software defects promptly. They help maintain the quality and functionality of the application by ensuring that all issues are identified, tracked, and addressed systematically.

Title
A brief, descriptive title of the bug (e.g., "Login button not working on mobile devices").

Reported by
Name of the person reporting the bug.

Date
The date when the bug was reported.

Description
A detailed description of the issue. Explain what is happening and what should happen instead.

Steps to Reproduce
List the steps taken to reproduce the bug. These steps should be easy to follow by anyone.

Expected Result
Describe what should happen when the steps are followed.

Actual Result
Describe what actually happens when the steps are followed.

Severity
Indicate the severity of the bug. Does it stop a planned release? Is it so severe someone must fix it ASAP? Is it just an slight improvement and a fix can wait?

Environment
Include relevant details about the environment where the bug was observed. (e.g., device information, operating system, browser, app version.)

Screenshots/Video
Attach any relevant screenshots or video recordings that illustrate the bug.

Additional Information
Add any other relevant information that might help in diagnosing the issue (e.g., error messages, console logs).

Copy this bug report template into your bug tracking tool and use it as a template for all new bugs. This templates gives you a great foundation to organize your bugs. This will help you keep track of the current bugs in you system and their current status.

Improve you bug reporting with Whitespace

While a thorough bug report is vital to keep track of your bugs they can be tedious write and maintain. Whitespace severely cuts down the time to report and solve bugs. It lets you recording a bug straight in your browser and attach it to a bug report in your bug tracking tool. Whitespace automatically fills out the Reported by, Date, Description, Steps to Reproduce, Actual Result, Environment, Screenshots/Video and Additional Information and packages it up in a video recording sharables as a link.

Read more about Whitespace