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

Update CONTRIBUTING.md.

Browse Source
This commit is contained in:
ccd0 2015-03-11 17:07:55 -07:00
parent 6558db6882
commit 20e8ded19c
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@ -1,14 +1,13 @@
## Reporting bugs and suggestions ## Reporting bugs
Reporting bugs: 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. Make sure both your **browser** and **4chan X** are up to date. 1. Include precise steps to reproduce the problem, with the expected and actual results.
2. Disable your other extensions & scripts to identify conflicts. 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. If your issue persists, open a [new issue](https://github.com/ccd0/4chan-x/issues) with the following information: 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.
1. Precise steps to reproduce the problem, with the expected and actual results. 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.
2. Console errors, if any. 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.
3. 4chan X version, browser variant, browser version, and Greasemonkey version if you are using it. 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.
4. Your exported settings. If your settings contains sensitive information (e.g. personas), edit the text file manually.
## Development & Contribution ## Development & Contribution
@ -23,10 +22,13 @@ Reporting bugs:
### Build ### Build
- Build with `grunt`. - Build with `grunt`.
- Continuously build with `grunt watch`. - You can continuously build with `grunt watch`.
### Contribute ### Contribute
- Edit the sources. - Edit the sources **(not the compiled scripts in the builds/ directory)**.
- If the edits affect regular users, edit the changelog. - Compile the script with `grunt`.
- Install the compiled script (found in the testbuilds/ directory), and test your changes.
- Open a pull request. - Open a pull request.
Archive list updates should go to https://github.com/MayhemYDG/archives.json.