Contributing

Submitting Issues

All bug reports and issues require a reduced test case.

Want to start a CodePen with a shuffle template? Use this: http://codepen.io/pen?template=qrjOpX

Take a look at the GitHub contributing guide. For demo links, please use things like CodePen, JSFiddle, or JS Bin to create reduced test cases. For more best practices when contributing, check out html5boilerplate's guide.

Without a reduced test case, your issue may be closed.

Releasing a new version

Update changelog.html.
Run tests.
Commit changes.
npm version major|minor|patch.
npm publish
git push && git push --tags
Create a new release on GitHub.

Running locally

This project uses Jekyll.

Head over to their quickstart guide to setup jekyll.
Install npm dependencies npm install.
Run npm run watch to rebuild, start the jekyll server, and watch for changes.
go to http://localhost:4000 to see it.