Bug reporting - Format and Template
Note (skip to bottom if you’re just here for the template itself)
We at Brave are strong proponents of open source collaboration. We would not be where we are without the help of our amazing community (that’s you!). As our user base grows in size it also grows in diversity. While we love watching our community expand, this also presents new challenges. From a support standpoint, the discrepancy between users who have had significant exposure to the tech/software development process and those who are new to it (or those who aren’t interested in it) is particularly challenging.
We, of course, aim to treat everyone equally but we can’t expect everyone to have the same skill set or background - yet the team does have some preferred expectations of the user so that we can quickly and accurately address an problem with the product.
In response to this Support is strengthening our efforts to meet everyone at their level when working through issues with Brave. To aid in this, we’ve streamlined the bug reporting process to make it easier for anyone to submit a report and explain why writing an clear, informative one is instrumental during development. The following are descriptions of each “section” of the bug report as well as a template (see bottom of post) for you to copy, paste, and fill out when you’re reporting a bug. Thank you for supporting Brave
Title of your post - We should be able to understand what your issue is without having to open the post (even though we will, obviously). A post titled: “Browser keeps Crashing” isn’t very helpful. Be more descriptive - try something like: “Brave crashes when I open more than five tabs”
What to say in each section in the template below:
Describe the issue - The more details we have surrounding your issue, the easier it is for us to solve.
Steps to Reproduce (STR) - This is a big one. When applicable, please provide for us the series of steps that you go through in order to reproduce the bug on your end. They should be clear and easy to follow. In the example above:
Open Brave Browser
Go to a website
Open new tab, go to another website
Repeat 3 more times
On 5th tab, open one more new tab
Actual Result - This is the result you get after performing the steps to reproduce (e.g, "Brave crashes)
Expected Result - This is the result the browse should be exhibiting (e.g, “6th tab opens”)
Reproduces How Often - Do your steps produce the same [incorrect] result every time? Half the time? Seemingly random? Tell us!
Brave version - Tell us what version of Brave you’re running. In the URL bar, typing in
about:brave will show all the information we need; feel free to copy and paste that into this section.
Reproducible on Live Release - For our triage/testing purposes it’s useful to know if this bug presents on the current live release of Brave.
Additional Info - Yes, more details! Feel free to put any additional configuration, related issues, system info, etc in this section. Anything that might be part of reproducing the bug or clue us in as to what’s causing it.
The process is not as cumbersome as it seems and it goes a long way towards helping the team quickly investigate and address issues. Can’t wait to see all your lovely reports
TEMPLATE (copy and paste this when reporting an issue):
Description of the issue:
Steps to Reproduce (add as many as necessary):
Actual Result (gifs and screenshots are welcome!):
Reproduces how often:
Reproducible on current live release (yes/no):
*Note: When reporting, screenshots and gifs are very helpful when troubleshooting and greatly appreciated. if you’d like to submit a gif of you reproducing the bug, LICEcap is a free, lightweight, easy to use app that records screen activity and converts it into gif format.