You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,28 +10,29 @@ Create your own fork of contrib where you can make your changes.
10
10
11
11
## 3. Install development dependencies
12
12
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.
14
14
15
15
## 4. Change the code
16
16
17
17
Make your code changes, ensuring they adhere to the same [coding style as Underscore][style]. Do **not** edit the files in `dist/`.
18
18
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.
20
20
21
21
## 5. Update the docs
22
22
23
23
Make any necessary documentation updates in `docs/`. Do **not** edit `index.html` directly.
24
24
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.
26
26
27
27
## 6. Send a pull request
28
28
29
29
Send a pull request to `documentcloud/underscore-contrib` for feedback.
30
30
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.
32
32
33
33
And hopefully your pull request will be merged by the core team! :-)
0 commit comments