Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

32 lines (22 loc) · 1.72 KB
Raw

Contributing

Important notes

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!

Code style

Regarding code style like indentation and whitespace, follow the conventions you see used in the source already.

PhantomJS

See the Why does grunt complain that PhantomJS isn't installed? guide in the Grunt FAQ for help with installing or troubleshooting PhantomJS.

Modifying the code

First, ensure that you have the latest Node.js and npm installed.

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.

Note that in Windows, you may have to run grunt.cmd instead of grunt.

  1. Fork and clone the repo.
  2. Run npm install to install all dependencies (including grunt).
  3. Run grunt to grunt this project.

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.

Submitting pull requests

  1. Create a new branch, please don't work in your master branch directly.
  2. Add failing tests for the change you want to make. Run grunt to see the tests fail.
  3. Fix stuff.
  4. Run grunt to see if the tests pass. Repeat steps 2-4 until done.
  5. Update the documentation to reflect any changes.
  6. Push to your fork and submit a pull request.