4chan-x/CONTRIBUTING.md at fe8c67e03ef4af5ce4b05fafdcb39410c2a78c5f

Zixaphir fe8c67e03e Merge branch 'v3'

Conflicts:
	CHANGELOG.md
	CONTRIBUTING.md
	LICENSE
	README.md
	builds/appchan-x.user.js
	builds/crx/manifest.json
	builds/crx/script.js
	latest.js
	package.json
	src/Filtering/PostHiding.coffee
	src/Filtering/ThreadHiding.coffee
	src/General/Config.coffee
	src/General/Header.coffee
	src/General/Index.coffee
	src/General/Main.coffee
	src/General/Navigate.coffee
	src/General/Settings.coffee
	src/General/UI.coffee
	src/General/html/Features/Index-navlinks.html
	src/Miscellaneous/CustomCSS.coffee
	src/Posting/QR.captcha.coffee
	src/Posting/QR.coffee
	src/Quotelinks/QuoteBacklink.coffee
	src/Quotelinks/QuoteYou.coffee

2014-03-06 20:15:45 -07:00

2.3 KiB

Raw Blame History

Reporting bugs and suggestions

Reporting bugs: (note that some of these links refer to Mayhem's 4chan X repo to avoid duplication of information resources. Bugs MUST be filed on our issue tracker, not Mayhem's)

Make sure both your browser and Appchan X are up to date.
Only Chrome, Firefox and Opera are supported.
SRWare Iron, Firefox ESR, Pale Moon, Waterfox, and other derivatives are not supported, use them at your own risk. This means that issue reports made with these browsers will be ignored unless you're able to duplicate it on a supported browser.
Look at the list of known problems and solutions.
Disable your other extensions & scripts to identify conflicts.
If your issue persists, open a new issue with the following information:
Precise steps to reproduce the problem, with the expected and actual results.
Console errors, if any.
Appchan X version, browser variant, browser version, and Greasemonkey version if you are using it.
Your exported settings. If your settings contains sensible information (e.g. personas), edit the text file manually.

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 Appchan X.
cd into it.
Install/Update Appchan 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 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.

2.3 KiB Raw Blame History