Contributing
So you're interested in giving us a hand? That's awesome! We've put together some brief guidelines that should help you get started quickly and easily.
Please, if you see anything wrong you can fix/improve it 
Installing the project
- Fork this project on github
- Clone this project on your local machine
- Then, you need to install
nodeandnpmto run the mainly packages. - After installed
nodeandnpm, run this script:
$ npm installThat's it! You're done.
How to work
We are using a bunch of things to put all together and make the work easy.
| Dependency | Description |
|---|---|
| NPM | Node package manager |
| BrowserSync | Create a localhost server with livereload |
| Webpack | Generated a UMD bundled version |
So, have some scripts that you need to know to run the project locally. It's just fews, but it's very important.
| Command | Description |
|---|---|
npm run build |
run $ wepback and babel task |
npm test |
lints files |
Submitting a Pull request
- Create your feature branch: git checkout -b feature/my-new-feature (or if you have a fix create your fix branch: git checkout -b fix/fix-that-thingy)
- Commit your changes: git commit -m 'Add some feature'
- Push to your remote fork branch: git push origin feature/my-new-feature:feature/my-new-feature
- Submit a pull request :D
- DFTBA