4chan-x/CONTRIBUTING.md

Reporting bugs and suggestions

Reporting bugs:

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

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 sources.
• If the edits affect regular users, edit the changelog.
• Open a pull request.