CONTRIBUTING.md

Foundation

This is the Foundation project. We love making super awesome stuff, but even more we like to empower people to make changes on their own. Feel free to fork and improve Foundation.

Compass Project

If you have a compass project and would like updated assets you can run the following command at any given time from within your project directory:

compass create -r zurb-foundation --using foundation

Development

Want to test out the Compass templates. Don't recompile the gem every time, use bundler like so:

mkdir demo1
cd demo1
echo -e 'source "https://rubygems.org"\n
gem "zurb-foundation", :path => "/path/to/foundation/repo"\n
gem "compass"\n' > Gemfile
bundle exec compass create -r zurb-foundation --using foundation

On subsequent template updates use:

bundle exec compass create -r zurb-foundation --using foundation --force

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Test your changes to the best of your ability. We've provided a test/ folder, feel free to add to it as necessary.
4. Update the documentation to reflect your changes if they add or changes current functionality. Make sure you are in the docs folder, then run bundle && bundle exec foreman start to compile to documentation.
5. Commit your changes (git commit -am 'Added some feature')
6. Push to the branch (git push origin my-new-feature)
7. Create new Pull Request