-
Notifications
You must be signed in to change notification settings - Fork 0
Home
The title is a vital part of a bug report that allows the developer and triager to quickly identify a unique issue. A well-written title should contain a clear, brief explanation of the issue, emphasizing the most important points.
Clear example: The export function to pdf of the "tal" page is not working
Unclear example: The button does not work
Preconditions
Describing preconditions is a great start. Be sure to provide information on system configuration, project type, and languages used. Basically, we need everything that could help us set up the same environment you have.
Steps to Reproduce
This is the most important part of a bug report, as we'll use this information to reproduce the issue. The issue is more likely to be fixed if it can be reproduced.
Describe each step you have taken to reproduce the issue. Try to include as much information as possible—sometimes even minor differences can be crucial.
Actual and Expected Results
These sections will help us make sure that everybody involved in the fix is on the same page. Describe the result you expected to get and the result you actually observed after performing the steps.
Additional Information
Additional information is often requested when the bug report is processed. You can save time by providing browser logs, screenshots, or any other artifacts related to the issue as needed.