James D. Forrester f81ce29bda Add a clean-up script for use as a pre-commit hook

Change-Id: I0e87cbd2d653f4125e2a3d40cda30a3464a7a287

2015-07-03 01:57:03 +00:00

Contributing to VisualEditor

Thank you for helping us develop VisualEditor!

We inherit the contribution guidelines from VisualEditor core. Be sure to read the Contribution guidelines in the VisualEditor repository.

Running tests

The VisualEditor plugins for MediaWiki can be tested within your MediaWiki install.

Configure your wiki to allow running of tests. In LocalSettings.php, set:

// https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing
$wgEnableJavaScriptTest = true;

Then open http://URL_OF_MEDIAWIKI/index.php/Special:JavaScriptTest/qunit (for example, http://localhost/w/index.php/Special:JavaScriptTest/qunit).

Node-based code linting tests can be run locally using npm – run:

npm install && npm test

A pre-commit git hook script exists which will help flag up any issues and avoid irritating code review steps for you and reviewers. Simply do:

ln -s bin/pre-commit.sh ../.git/hooks/pre-commit