Skip to content

Commit 2f3ef8f

Browse files
committed
Add CONTRIBUTING.md
1 parent 318bf46 commit 2f3ef8f

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
## Important notes
4+
Please don't edit `/jquery.stellar.js` and `/jquery.stellar.min.js` directly as they are generated via grunt. You'll find source code in the `src` subdirectory!
5+
6+
### Code style
7+
Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
8+
9+
### PhantomJS
10+
See the [Why does grunt complain that PhantomJS isn't installed?](https://github.com/gruntjs/grunt/blob/master/docs/faq.md#why-does-grunt-complain-that-phantomjs-isnt-installed) guide in the [Grunt FAQ](https://github.com/gruntjs/grunt/blob/master/docs/faq.md) for help with installing or troubleshooting PhantomJS.
11+
12+
## Modifying the code
13+
First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) installed.
14+
15+
Test that grunt is installed globally by running `grunt --version` at the command-line. If grunt isn't installed globally, run `npm install -g grunt` to install the latest version. _You may need to run `sudo npm install -g grunt`._
16+
17+
_Note that in Windows, you may have to run `grunt.cmd` instead of `grunt`._
18+
19+
1. Fork and clone the repo.
20+
1. Run `npm install` to install all dependencies (including grunt).
21+
1. Run `grunt` to grunt this project.
22+
23+
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.
24+
25+
## Submitting pull requests
26+
27+
1. Create a new branch, please don't work in your `master` branch directly.
28+
1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
29+
1. Fix stuff.
30+
1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
31+
1. Update the documentation to reflect any changes.
32+
1. Push to your fork and submit a pull request.

0 commit comments

Comments
 (0)