Goyslop/4chan-x
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CONTRIBUTING.md fixes.

Browse Source
This commit is contained in:
ccd0 2015-03-11 17:39:41 -07:00
parent a3a3119ead
commit 652988fd89
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -3,10 +3,10 @@
If I can't reproduce a bug, I probably won't be able to fix it. You can help by doing the following when you [report a bug](https://github.com/ccd0/4chan-x/issues):
1. Include precise steps to reproduce the problem, with the expected and actual results.
2. Make sure your **browser**, **4chan X**, and (if applicable) **Greasemonkey** are up to date. Include the versions you are using in bug reports.
3. Test if the bug occurs with 4chan X disabled and using the native extension. If it does, it may be a problem with 4chan or your browser.
4. Open your console (`Shift+Control+J` or `Shift+Command+J`), and look for any errors messages, especially ones that occur at the same time as the bug. Include these in your bug report. If you're using Firefox, be sure to check the browser console (`Shift+Control+J`), not the Javascript console (`Shift+Control+K`) as errors may not show up in the latter.
5. To test if the bug occurs under the default settings or only with specific settings, back up your settings and reset them using the `Export` and `Reset Settings` links in the settings panel. If the bug only occurs under specific settings, upload your exported settings to a site like [Pastebin](http://pastebin.com/), and link to it in your bug report. If your settings contains sensitive information (e.g. personas), edit the text file manually.
2. Make sure your **browser**, **4chan X**, and (if applicable) **Greasemonkey** are up to date. Include the versions you're using in bug reports.
3. Test if the bug occurs with 4chan X disabled and using the native extension. If it does, it's likely a problem with 4chan or your browser rather than with 4chan X.
4. Open your console with Shift+Control+J (⇧⌘J on OS X Firefox, ⌘⌥J on OS X Chromium), and look for any error messages, especially ones that occur at the same time as the bug. Include these in your bug report. If you're using Firefox, be sure to check the browser console (Shift+Control+J), not the web console (Shift+Control+K) as errors may not show up in the latter.
5. To test if the bug occurs under the default settings or only with specific settings, back up your settings and reset them using the **Export** and **Reset Settings** links in the settings panel. If the bug only occurs under specific settings, upload your exported settings to a site like [Pastebin](http://pastebin.com/), and link to it in your bug report. If your settings contains sensitive information (e.g. personas), edit the text file manually.
6. To check if a bug is due to a conflict with another extension, temporarily disable any other extensions and userscripts. If the bug goes away, turn them back on one by one until you find the one causing the problem.
## Development & Contribution
@ -26,7 +26,7 @@ If I can't reproduce a bug, I probably won't be able to fix it. You can help by
### Contribute
- Edit the sources **(not the compiled scripts in the builds/ directory)**.
- Edit the sources (not the compiled scripts in the builds/ directory).
- Compile the script with `grunt`.
- Install the compiled script (found in the testbuilds/ directory), and test your changes.
- Open a pull request.