uBlock/CONTRIBUTING.md

54 lines
2.6 KiB
Markdown
Raw Normal View History

# Submitting issues
2015-06-21 19:02:44 -06:00
Any issue opened without effort to provide the required details for me to reproduce the problem will be closed as _invalid_. If you provide more details thereafter for me to reproduce the issue, I will reopen the it.
2015-06-21 15:40:52 -06:00
***
2015-04-17 06:06:15 -06:00
### Before you submit
2015-04-08 18:56:41 -06:00
1. Submit **bugs/issues only**.
2015-04-08 18:57:37 -06:00
- Bugs occur, I will fix them.
2015-06-22 21:49:42 -06:00
1. The logger is the tool of choice to use to help diagnose issues.
2015-04-08 19:07:35 -06:00
1. Do **NOT**:
- Submit design ideas.
- Submit feature requests.
- Submit "revolutionary ideas".
- Post comments like "+1" or "me too!" without providing new relevant info on the issue.
- Use issues as replacement for threads on a bulletin board. [You can use Reddit](https://www.reddit.com/r/ublock+ublockorigin) for general discussion among users.
2015-04-08 18:56:41 -06:00
- Any such issue will be closed without comment.
1. Make sure your issue [hasn't already been fixed in a recent release](https://github.com/gorhill/uBlock/releases).
1. Verify that the issue does **not** occur with uBlock disabled.
1. Verify that the issue is not related to a 3rd-party filter lists.
2015-06-21 15:40:52 -06:00
1. Verify that the issue is not caused by another extension.
2015-04-08 18:56:41 -06:00
2015-06-21 15:40:52 -06:00
***
### What to include
2015-04-08 18:56:41 -06:00
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
2015-06-21 15:40:52 -06:00
* **Always include a URL**, _even_ if "it happens everywhere".
* 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
2015-06-22 21:49:42 -06:00
* Include whatever relevant the logger reports.
2015-04-29 08:38:38 -06:00
* A screenshot or transcription 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](https://github.com/gorhill/uBlock/wiki/Quick-guide:-popup-user-interface)
* Example: `uBlock 0.9.0.0`
* The browser you're using and its version
2015-04-08 18:56:41 -06:00
* Examples: `Firefox 36`, `Chrome 41.0.2272`
* The OS you're using and its version
2015-04-08 18:56:41 -06:00
* 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
2015-04-08 18:56:41 -06:00
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.
2015-06-21 15:40:52 -06:00
***
**Good read:** [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).