Skip to content

Commit fca24f9

Browse files
docs(CONTRIBUTING): update contributing file with npm scripts info
1 parent 1f98cee commit fca24f9

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,13 @@ If your issue gets labeled with purple label, no further action will be taken un
4949

5050
# Developing
5151

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

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

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

60-
There are a number of targets in the gruntfile that are used to generating different builds:
61-
62-
* `grunt`: Perform a normal build, runs jshint and karma tests
63-
* `grunt build`: Perform a normal build
64-
* `grunt dist`: Perform a clean build and generate documentation
65-
* `grunt dev`: Run dev server (sample app) and watch for changes, builds and runs karma tests on changes.
59+
* `npm test`: runs the entire test suite.
60+
* `npm run build`: Perform a full build.
61+
* `npm run watch`: Continuously runs the tests when source or tests change.

0 commit comments

Comments
 (0)