Skip to content

Commit d977fb4

Browse files
committed
contributing
1 parent 464d062 commit d977fb4

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,20 @@ Please don't edit files in the `dist` subdirectory as they are generated via Gru
66
### Code style
77
Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
88

9-
### PhantomJS
10-
While Grunt can run the included unit tests via [PhantomJS](http://phantomjs.org/), this shouldn't be considered a substitute for the real thing. Please be sure to test the `test/*.html` unit test file(s) in _actual_ browsers.
11-
129
## Modifying the code
1310
First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
1411

15-
Test that Grunt's CLI is installed by running `grunt --version`. If the command isn't found, run `npm install -g grunt-cli`. For more information about installing Grunt, see the [getting started guide](http://gruntjs.com/getting-started).
16-
1712
1. Fork and clone the repo.
1813
1. Run `npm install` to install all dependencies (including Grunt).
19-
1. Run `grunt` to grunt this project.
14+
1. Run `gulp server` to run the server and start debugging the library.
2015

2116
Assuming that you don't see any red, you're ready to go. Just be sure to run `grunt` after making any changes, to ensure that nothing is broken.
2217

2318
## Submitting pull requests
2419

2520
1. Create a new branch, please don't work in your `master` branch directly.
26-
1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
21+
1. Add failing tests for the change you want to make. Run `npm test` to see the tests fail.
2722
1. Fix stuff.
28-
1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
29-
1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
23+
1. Run `npm test` to see if the tests pass. Repeat steps 2-4 until done.
3024
1. Update the documentation to reflect any changes.
3125
1. Push to your fork and submit a pull request.

0 commit comments

Comments
 (0)