Skip to content

Commit

Permalink
docs(CONTRIBUTING): update contributing file with npm scripts info
Browse files Browse the repository at this point in the history
  • Loading branch information
christopherthielen committed Aug 31, 2016
1 parent 1f98cee commit fca24f9
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,13 @@ If your issue gets labeled with purple label, no further action will be taken un

# Developing

UI-Router uses <code>grunt >= 0.4.x</code>. Make sure to upgrade your environment and read the
[Migration Guide](http://gruntjs.com/upgrading-from-0.3-to-0.4).
UI-Router uses <code>npm</code> and <code>webpack</code>.
After cloning the ui-router repository, fetch the dependencies for building from source and running tests:

Dependencies for building from source and running tests:
* run `$ npm install` from the project directory

* [grunt-cli](https://github.com/gruntjs/grunt-cli) - run: `$ npm install -g grunt-cli`
* Then, install the development dependencies by running `$ npm install` from the project directory
There are a number of scripts in the package.json that are used to generate builds and run tests:

There are a number of targets in the gruntfile that are used to generating different builds:

* `grunt`: Perform a normal build, runs jshint and karma tests
* `grunt build`: Perform a normal build
* `grunt dist`: Perform a clean build and generate documentation
* `grunt dev`: Run dev server (sample app) and watch for changes, builds and runs karma tests on changes.
* `npm test`: runs the entire test suite.
* `npm run build`: Perform a full build.
* `npm run watch`: Continuously runs the tests when source or tests change.

0 comments on commit fca24f9

Please sign in to comment.