Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.38 KB
Raw

Contributing

Important notes

Please don't edit files in the dist subdirectory 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.

Modifying the code

Ensure that you have Node.js and npm installed. The best way to do it is through NVM.

Ensure that you have Ruby and RubyGems installed. The best way to do it is through RVM.

  1. Fork and clone the repo.
  2. Run gem install bundler to install Bundler.
  3. Run bundle install --path=vendor/bundle to install compass.
  4. Run npm install -g grunt-cli to install grunt command line globally.
  5. Run npm install to install all dependencies (including grunt).
  6. 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. Fix stuff.
  3. Add examples if you are adding a new feature.
  4. Run grunt to see if there are warnings/errors.
  5. Push to your fork and submit a pull request.