1 | [Grunt homepage](https://github.com/cowboy/grunt) | [Documentation table of contents](toc.md)
|
2 |
|
3 | # Contributing to grunt
|
4 |
|
5 | If you want to make contributions to grunt, by all means, please do so. "Patches welcome."
|
6 |
|
7 | ## Discussing grunt
|
8 |
|
9 | Join the [freenode](http://freenode.net/) #grunt IRC channel. We've got a bot and everything.
|
10 |
|
11 | ## Filing issues
|
12 |
|
13 | If something isn't working like you think it should, read the [API documentation](api.md). If it still isn't working like you think it should, [file an issue](https://github.com/cowboy/grunt/issues). If you'd like to chat directly, pop into IRC.
|
14 |
|
15 | ## Cloning grunt
|
16 |
|
17 | first, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
|
18 |
|
19 | Fork grunt in GitHub, and clone it locally:
|
20 |
|
21 | ```bash
|
22 | git clone git://github.com/YOURUSERNAME/grunt.git && cd grunt
|
23 | ```
|
24 |
|
25 | To download grunt dependencies and add the development `grunt` bin script to your path:
|
26 |
|
27 | ```bash
|
28 | npm install && npm link
|
29 | ```
|
30 |
|
31 | ## Reverting back to the "live" grunt
|
32 |
|
33 | If, for some reason, you need to revert back to the current npm grunt release, just reinstall grunt globally via:
|
34 |
|
35 | ```bash
|
36 | npm install -g grunt
|
37 | ```
|
38 |
|
39 | ## Actually contributing
|
40 |
|
41 | In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Fork, tweak, and make pull requests.. but `grunt` grunt first:
|
42 |
|
43 | ```bash
|
44 | grunt
|
45 | ```
|
46 |
|
47 | _(you shouldn't see any red or yellow when you do this)_
|
48 |
|
49 | ## One final note about contributing
|
50 |
|
51 | I'll be completely up-front: while you know that your idea is well-reasoned and executed, I might need to be convinced of the value of incorporating it into grunt, because it might not be immediately apparent to me. Don't lose hope! All I ask is that you include, along with your pull request, an explanation of how your code is going to improve grunt. Thanks!
|