Mirrors
/
uBlock
mirror of https://github.com/gorhill/uBlock.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

editing

This commit is contained in:
gorhill 2015-06-21 17:40:52 -04:00
parent 19487f10cd
commit 86eb558f43
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -1,6 +1,8 @@
# Submitting issues # Submitting issues
**Must read:** [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html). Any issue opened with no effort to provide the required details **for me to reproduce** it will be closed as _invalid_.
***
### Before you submit ### Before you submit
@ -15,15 +17,10 @@
- Any such issue will be closed without comment. - 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. 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 does **not** occur with uBlock disabled.
- If it still occurs with uBlock disabled, it's probably not an issue with uBlock.
1. Verify that the issue is not related to a 3rd-party filter lists. 1. Verify that the issue is not related to a 3rd-party filter lists.
- If it is the case, report to the list maintainer(s). 1. Verify that the issue is not caused by another extension.
- 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.
1. Verify that the issue is not caused by another extension, such as HTTPS Everywhere.
1. Any issue opened with no effort to provide the required details will be closed without comment.
--- ***
### What to include ### What to include
@ -31,7 +28,7 @@
To help diagnose and fix the bug/issue, please always, **always**, **ALWAYS** include the following in your report: 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 * A clear list of steps to reproduce the problem
* **Always include a URL**, _even_ if "it happens everywhere". Just do it. * **Always include a URL**, _even_ if "it happens everywhere".
* Symptoms of the issue * Symptoms of the issue
* Describe what you observe and consider broken behavior; this is what we'll be looking for after executing the steps * 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 * Example: video doesn't start playing, page layout broken
@ -48,3 +45,7 @@ To help diagnose and fix the bug/issue, please always, **always**, **ALWAYS** in
* Tip: try disabling them and see if your issue still occurs * 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. 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.
***
**Good read:** [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).