How do I submit a bug report? Follow
The software development process is often an arduous one. Large scale applications can contain millions of lines of code that need to work across multiple platforms as well as account for a nearly infinite number of possible conditions at runtime. Subsequently, software at this scale is rarely perfect and may not always behave as intended. We generally refer to flaws, errors, or otherwise unintended behavior as bugs.
Brave is a new, innovative, and ambitious project with many moving parts. While our team is extremely talented and driven, you're likely to encounter bugs sometimes while browsing. You can help us continue to improve our product and deliver a better browsing experience by bringing these bugs you encounter to our attention. The best way to do that is by visiting our Community website and posting the issue you are encountering for our Support and Brave Team staff to see.
As we continue to grow, so do the number of support requests we receive. Before you post to Community, take a moment to do the following:
- Look through this knowledge base
It's built to address many common questions and known issues. While still a work in progress, content will be regularly added and is always worth checking here first to see if your issue is covered.
- Look for Duplicates
Given the amount of reports/request we get each day, there's a good chance that someone else may have raised your issue already or may have been resolved. Before posting, use the search bar on the top-right corner of the website to see if other users have raised the same concern.
When posting a new topic on Community, you may notice that that the editor comes pre-filled with some information. What you're seeing is the bug reporting template we've inserted to make submitting support requests and reporting issues as simple as possible.
Read the instructions at the top of the template and simply insert your information below the appropriate section. When properly filled the template will ideally tell Brave team members all they need to know about the problem you're having at a glance and eliminates unnecessary back and fourth responses used to discern some basic information needed to diagnose an issue. Additionally, the title of your post should be succinct and informative.
When filled out properly, your report should look something like this:
Description of the issue:
Brave will not open any new tabs except when opened from the context menu (right-click menu).
Steps to Reproduce (add as many as necessary):
1. Launch Brave
2. Visit any website, then press CTRL + T (or CMD + T) to open a new tab
3. Repeat for additional ways tabs are opened - clicking on the + sign on tab bar, from main menu, etc.
Actual Result (gifs and screenshots are welcome!):
New tab is not opened
A new tab should be opened
Reproduces how often:
Brave Version(See the About Brave page in the main menu):
Brave release - v0.60.0
Reproducible on current live release (yes/no):
I'm using macOS Mojave v 10.1.14
For users who are new to bug reporting and open source development, I've outlined the type of information to include when filling out each section of the template:
- Description of the Issue
While it may seem obvious, this section will comprise the bulk of your report and not all descriptions are useful. We encourage anyone reporting provide as much detail about the issue in question as possible.
Bad Description Example: "Some videos work in Brave."
Good Description Example: "Youtube videos won't play in Brave. When attempting to stream the player stays black and the loading symbol spins infinitely. When trying with Shields down, the ad before the video will play, but the actual content continues to load infinitely once the ad is done."
- Steps to Reproduce
It is often useful to know the exact steps taken that produce the behavior you detailed in your description of the issue. STR is different from the issue description in that it's comprised of a numbered list of clearly defined and easy to follow actions that one would execute that produce the issue described.
1. Launch Brave
2. Navigate to YouTube
3. Try to stream a video
4. Turn Shields off and try streaming again
- Actual Result
This is the result you see after performing the above steps on your end. Almost like a short form version of your issue.
Example: With Shields up video player shows loading screen forever - with shields down, ad before video plays, then returns to loading screen forever.
- Expected result
This is what you (specifically) think should be happening after performing the above steps.
Example: The selected video streams.
- Reproduces Consistently?
Tell us in a word or two how often the issue occurs. Is it something that happens every time or is it intermittent and if so, how hard is it to produce/capture the issue?
Example: Every time
- Brave Version
Knowing what Brave build and version number you're using can help see whether or not the issue is new, known, or a previously known bug that was resolved but is now appearing again (regression). It also confirms whether or not your browser has the latest updates and fixes which may be the cause of the bug. You can find your version and build information by going to selecting About Brave from the Main menu.
Example: Version 0.55.22 Chromium: 70.0.3538.77 (Official Build) (64-bit)
- Additional Information
Any additional details you'd like to add or comments to make once the above sections are filled you can put here. Screen shots or screen recordings are also particularly valuable when diagnosing an issue although they're certainly not required. If you choose to include them in your report leave them here.
Please provide information in as many sections as possible to help us resolve or log your issue as efficiently as possible. The entirety of the example issue used above is ~530 characters total (less than two Tweets!).
NOTE: Any "One liner", overtly vague, or bug reports/support requests that otherwise entirely ignore the above guidelines will not be responded to. Repeatedly posting such articles will get you flagged or banned.