4chan-x/CONTRIBUTING.md

Reporting bugs and suggestions

Reporting bugs:

1. Make sure both your browser and 4chan X are up to date.
2. Look at the list of known problems and solutions.
3. Disable your other extensions & scripts to identify conflicts.
4. If your issue persists, open a new issue with the following information:
5. Precise steps to reproduce the problem, with the expected and actual results.
6. Console errors, if any.
7. 4chan X version, browser variant, browser version, and Greasemonkey version if you are using it.
8. Your exported settings. If your settings contains sensible information (e.g. personas), edit the text file manually.

Open your console with:

• Ctrl + Shift + J on Chrome and Opera.
• Ctrl + Shift + K on Firefox.

Respect these guidelines:

• Describe the issue clearly, put some effort into it. A one-liner isn't a good enough description.
• If you want to get your suggestion implemented sooner, make it convincing.
• If you want to criticize, make it convincing and constructive.
• Be mature. Act like an idiot and you will be blocked without warning.

Development & Contribution

Get started

• Install node.js.
• Install Grunt's CLI with npm install -g grunt-cli.
• Clone 4chan X.
• cd into it.
• Install/Update 4chan X dependencies with npm install.

Build

• Build with grunt.
• Continuously build with grunt watch.

Release

• Update the version with grunt patch, grunt minor or grunt major.
• Release with grunt release.

Note: this is only used to release new 4chan X versions, and is not needed or wanted in pull requests.

Contribute

• Edit the CoffeeScript sources.
• If the edits affect regular users, edit the changelog.
• Open a pull request.