Skip to content

Commit 5abd0e9

Browse files
committed
Update the CONTRIBUTING to reflect the adoption of Yarn
1 parent c2974ed commit 5abd0e9

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,29 @@ Create your own fork of contrib where you can make your changes.
1010

1111
## 3. Install development dependencies
1212

13-
Make sure you have [Node.js][node] and the [grunt cli][cli] installed. Then install contrib's development dependencies with `npm install`.
13+
Make sure you have [Node.js][node] and [Yarn][yarn] installed. Then install contrib's development dependencies with `yarn`. Note that these dependencies include the [Grunt CLI][cli] which we use for task automation.
1414

1515
## 4. Change the code
1616

1717
Make your code changes, ensuring they adhere to the same [coding style as Underscore][style]. Do **not** edit the files in `dist/`.
1818

19-
Make any necessary updates to the qUnit tests found in `test/`. Run `grunt test` to catch any test failures or lint issues. You can also use `grunt watch:test` to get instant feedback each time you save a file.
19+
Make any necessary updates to the qUnit tests found in `test/`. Run `yarn test` to catch any test failures or lint issues. You can also use `yarn grunt watch:test` to get instant feedback each time you save a file.
2020

2121
## 5. Update the docs
2222

2323
Make any necessary documentation updates in `docs/`. Do **not** edit `index.html` directly.
2424

25-
After updating the docs, run `grunt tocdoc` to rebuild the `index.html` file. Visually inspect `index.html` in your browser to ensure the generated docs look nice.
25+
After updating the docs, run `yarn tocdoc` to rebuild the `index.html` file. Visually inspect `index.html` in your browser to ensure the generated docs look nice.
2626

2727
## 6. Send a pull request
2828

2929
Send a pull request to `documentcloud/underscore-contrib` for feedback.
3030

31-
If modifications are necessary, make the changes and rerun `grunt test` or `grunt tocdoc` as needed.
31+
If modifications are necessary, make the changes and rerun `yarn test` or `yarn tocdoc` as needed.
3232

3333
And hopefully your pull request will be merged by the core team! :-)
3434

3535
[style]:https://github.com/documentcloud/underscore/blob/master/underscore.js
3636
[node]:http://nodejs.org/
37-
[cli]:http://gruntjs.com/getting-started#installing-the-cli
37+
[yarn]:https://yarnpkg.com
38+
[cli]:http://gruntjs.com/getting-started#installing-the-cli

0 commit comments

Comments
 (0)