Goyslop/4chan-x
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4chan-x/CONTRIBUTING.md
Nicolas Stepien 0a41f0ae6c Make Chrome ext/userscript/userjs builds.
2013-03-18 01:43:50 +01:00

1.2 KiB
Raw Blame History

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. Report precise steps to reproduce the problem.
  5. Report console errors, if any.
  6. Report browser version.
  7. Include your exported settings.

Open your console with:

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

Development & Contribution

Get started

  • Install node.js.
  • Install Grunt's CLI with npm install -g grunt-cli.
  • Clone 4chan X.
  • cd into it.
  • Install 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.