You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
# Contributing
|
|
|
|
## Submitting Issues
|
|
|
|
All bug reports and issues **require** a [reduced test case](https://css-tricks.com/reduced-test-cases/).
|
|
|
|
Want to start a CodePen with a shuffle template? Use this: [http://codepen.io/pen?template=qrjOpX](http://codepen.io/pen?template=qrjOpX)
|
|
|
|
Take a look at the GitHub [contributing guide](https://guides.github.com/activities/contributing-to-open-source/index.html). For demo links, please use things like [CodePen](http://codepen.io/), [JSFiddle](https://jsfiddle.net/), or [JS Bin](https://jsbin.com/) 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.
|
|
|
|
## Releasing a new version
|
|
|
|
* Update `changelog.html`.
|
|
* Run tests.
|
|
* Commit changes.
|
|
* `npm version major|minor|patch`.
|
|
* `npm publish`
|
|
* Create a [new release](https://github.com/Vestride/Shuffle/releases/new) on GitHub.
|
|
|
|
## Running locally
|
|
|
|
This project uses [Jekyll](https://jekyllrb.com/).
|
|
|
|
* Head over to [their quickstart guide](https://jekyllrb.com/docs/quickstart/) 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.
|