Skip to content
This repository has been archived by the owner on Dec 11, 2019. It is now read-only.
Brian Clifton edited this page Dec 14, 2016 · 31 revisions
  • We have a development timeline if you'd like to see what features are planned and which are coming soon

  • We also have a community which you can participate in! Come join us if you run into a bug, have questions, want to request a feature, or if you just want to say hi 😊

If you have questions about the features Brave offers, please check out the FAQ

For other specific issues, see the navigation bar over here =========>>

I'm having a problem loading a website

If you're experiencing an error, let's try a few troubleshooting steps:

Try going into Shields Down mode

  1. Click the Brave logo in the top right to bring up the Site Shield Settings modal
  2. Toggle the site from Up to Down
  3. The page should reload itself (if it doesn't, refresh the page manually)

If this works and you don't want to leave shields off, consider turning them back on and then disabling features one at a time. For example, fingerprint protection is a great feature, but it can cause problems with some websites.

Check the development console

You can bring up the developer console to see if the page you're running has any JavaScript errors which are causing the page to fail.

  • On Windows, you can bring this up with F12
  • On macOS, you can bring the tools up with Command+Option+I

If you're using a dev channel build, you can open a console that will show application output (errors initializing electron, etc). This can be brought up with Shift+F8.

Let us know about it

There are always bugs creeping out there and we'll do our best job to address them 😃

  • Use the issues tab here in GitHub to see if there's already an issue reported for the site you're having problems with. Since there are a lot of issues, you might find it handy to filter based on the webcompat tag.

  • If there is already an open issue in GitHub:

    • Sometimes folks will describe a work-around. This might help you get back up and running!
    • use the new Add your reaction feature to give it a +1 or leave a comment letting us know. This helps us not only know about the issue, but how the problem impacts you.
    • consider sharing specific details- does the problem happen all the time? Are there any errors in the browser's developer console? Do you have a screenshot that might be helpful?
  • If there is NOT an open issue in GitHub:

    • Let's create an issue 😃 Having an issue helps us become aware of the incompatibility so that we can start to look at understanding and fixing the issue.
    • When you create an issue, let's make sure we capture the following info
      • Version of Brave you're using (can be found in hamburger menu: Help > About Brave
      • Which OS you're using and which version (pro? 64 bit? for Linux, which window manager?)
      • Screenshots can be helpful
  • If you'd rather contact us directly, you always have that option too

    • Use the built in Help menu (Help > Report an Issue) to describe your issue to us
    • Similar to reporting an issue, please try to include as many details as possible about your situation

Contributing

We've got a great community and encourage everybody to help 😄

Help triage issues

  • One of the easiest ways to help is to look through our issues tab
  • Does the issue still happen? Sometimes we fix the problem and don't always close the issue
  • Are there clear steps to reproduce the issue? If not, let's find and document some
  • Is the issue a duplicate? If so, share the issue that is being duplicated in the conversation

Updating documentation

Documentation is extremely important. There are lots of areas we can improve:

  • Having more clear or up-to-date instructions in our README.md.
  • Updating the wiki pages here with helpful info

Work on the code

Deep dive: technical documentation

While detailed documentation is limited, we have a few great wiki entries which may help you understand the code-base and the behavior of Brave. Please feel free to edit them or add new pages as you learn more 😄