From 2471419b5b68468393bf6e58bdf0b94a638a0504 Mon Sep 17 00:00:00 2001 From: Rowan Manning Date: Tue, 5 Nov 2013 11:24:54 +0000 Subject: [PATCH] Add development instructions --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index a9caa31..b2c39a7 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,24 @@ The boot configurations for pa11y-dashboard are as follows. Look at the sample J *(number)* The port to run the application on. +Development +----------- + +To develop pa11y-dashboard, you'll need to clone the repo and get set up as outlined in the [setup guide](#setup). You'll also need [Grunt][grunt] to be installed globally in order to run tests, you can do this with `npm install -g grunt-cli`. + +Now you'll be able to run the following commands: + +```sh +$ grunt # Run the lint and test tasks together +$ grunt lint # Run JSHint with the correct config +$ grunt compile # Compile front-end assets +``` + +Code with lint errors or failing tests will not be accepted, please use the build tools outlined above. + +For users with push-access, don't commit to the master branch. Code should be in `develop` until it's ready to be released. + + License -------