Mirrors/uBlock
1
0
Fork 0
mirror of https://github.com/gorhill/uBlock.git synced 2024-11-01 16:33:06 +01:00
Code Issues Releases Wiki Activity
6a9585c056
uBlock/CONTRIBUTING.md
Raymond Hill 18660841cf Update CONTRIBUTING.md
2015-04-17 08:06:15 -04:00

2.4 KiB
Raw Blame History

Submitting issues

Must read: How to Report Bugs Effectively.

Before you submit

  1. Submit bugs/issues only.
    • Bugs occur, I will fix them.
  2. Do NOT:
    • Submit design ideas.
    • Submit feature requests.
    • Submit "revolutionary ideas".
    • Use issues as replacement for threads on a bulletin board.
    • Any such issue will be closed without comment.
  3. Make sure your issue hasn't already been fixed in a recent release.
  4. Verify that the issue does not occur with uBlock disabled.
    • If it still occurs with uBlock disabled, it's probably not an issue with uBlock.
  5. Verify that the issue is not related to a 3rd-party filter lists.
    • If it is the case, report to the list maintainer(s).
    • It helps to also test with Adblock Plus, with same filter lists.
      • If issue also occurs with ABP, it's most likely a filter list issue.
  6. Any issue opened with no effort to provide the required details will be closed without comment.

What to include

To help diagnose and fix the bug/issue, please always, always, ALWAYS include the following in your report:

  • A clear list of steps to reproduce the problem
    • Always include a URL, even if "it happens everywhere". Just do it.
  • Symptoms of the issue
    • Describe what you observe and consider broken behavior; this is what we'll be looking for after executing the steps
    • Example: video doesn't start playing, page layout broken
  • A screenshot of any of uBlock's preferences that differ from the defaults
    • This includes a whitelisted website, enabled/disabled filter list, anything
    • Please do include everything different from the defaults whether or not it seems relevant to your issue
  • The version of uBlock you're having the issue with; you can find this in uBlock's popup UI
    • Example: uBlock 0.9.0.0
  • The browser you're using and its version
    • Examples: Firefox 36, Chrome 41.0.2272
  • The OS you're using and its version
    • Examples: Windows 8.1, Linux Mint 17.1
  • A list of other extensions you have installed
    • Tip: try disabling them and see if your issue still occurs

Otherwise, we've noticed that a lot of your time (and the developers') gets thrown away on exchanging back and forth to get this information.