We would love for you to contribute and help us make this even better! Start reading this document to see it is not difficult as you might have imagined.
- Open an Issue
- Submit a Pull Request
- Style Guide
- Test
- [Development][#development]
- Code of Conduct
- License
Open an Issue to report any problems or improvements. When necessary, use some online service like JS Bin, JSFiddle, Codepen, to show the problem. Be sure to include some description to explain the problem.
To submit a new feature, make sure that changes are done to the source code. Follow our style guide and do not forget the tests.
Try to solve a problem for each pull request, this increases the chances of acceptance. When in doubt, open a new issue so we can answer you. Look existing issues for ideas or to see if a similar issue has already been submitted.
- Fork the GitHub repo:
git clone https://github.com/repo/name.git - Create a new branch:
git checkout -b feature/issuenumber-featurename - Commit your changes:
git commit -m 'issuenumber description' - Push to the branch:
git push origin feature/issuenumber-featurename - Submit a pull request!
Look at how the code is being maintained, we must always be consistent. We try to follow best practices as much as possible.
NOTE: The best way to learn about that is to just install it and give it a try on your code.
First install Node.js. Now install all the dependencies, run npm install from the project directory. Once you have the dependencies installed, run npm test.
Help us keep this project open and inclusive. Please read and follow our thoughts on Code of Conduct.
By contributing your code, you agree to license your contribution under the MIT license.