Add separate contributing file.

so GitHub will show it to people before submitting issues.
pull/56/head
Glen Cheney 10 years ago
parent 66ef613dff
commit 3150066f66

@ -0,0 +1,12 @@
## Running locally
This project uses [Jekyll](http://jekyllrb.com/).
* Head over to [their quickstart guide](http://jekyllrb.com/docs/quickstart/) to setup jekyll.
* Install npm dependencies `npm install`.
* Run `grunt serve` to tell Jekyll to watch for changes.
* To watch for and compile changes to scss and shuffle src js files, run `grunt watch` in a separate tab.
* go to `http://localhost:4000` to see it.
## Submitting Issues
All bug reports and issues **require** a [reduced test case](http://css-tricks.com/reduced-test-cases/). You can take a look at the [contributing guide](https://guides.github.com/overviews/os-contributing/#contributing) here on GitHub too. For demo links, please use things like [CodePen](http://codepen.io/) or [JSFiddle](http://jsfiddle.net/) to create reduced test cases. For more best practices when contributing, check out [html5boilerplate's guide](https://github.com/h5bp/html5-boilerplate/blob/master/CONTRIBUTING.md).
Without a reduced test case, your issue may be closed.

@ -11,18 +11,5 @@ bower install shufflejs
## Shuffle 2.0
This is a large improvement to shuffle. Most notably, the ability for [masonry](http://masonry.desandro.com) layouts. Other additions include adding/removing items, enabling/disabling, multiple instances on a page, and more!
## Running locally
This project uses [Jekyll](http://jekyllrb.com/).
* Head over to [their quickstart guide](http://jekyllrb.com/docs/quickstart/) to setup jekyll.
* Install npm dependencies `npm install`.
* Run `grunt serve` to tell Jekyll to watch for changes.
* To watch for and compile changes to scss and shuffle src js files, run `grunt watch` in a separate tab.
* go to `http://localhost:4000` to see it.
## Submitting Issues
All bug reports and issues **require** a [reduced test case](http://css-tricks.com/reduced-test-cases/). You can take a look at the [contributing guide](https://guides.github.com/overviews/os-contributing/#contributing) here on GitHub too. For demo links, please use things like [CodePen](http://codepen.io/) or [JSFiddle](http://jsfiddle.net/) to create reduced test cases. For more best practices when contributing, check out [html5boilerplate's guide](https://github.com/h5bp/html5-boilerplate/blob/master/CONTRIBUTING.md).
Without a reduced test case, your issue may be closed.
## Inspiration
This project was inspired by [Isotope](http://isotope.metafizzy.co/) and [Packery](http://packery.metafizzy.co/).

Loading…
Cancel
Save