Want to contribute? Awesome!!!
If you find a bug, or have a new feature idea, please start by making sure it hasn't already been reported. You can search through existing issues to see if there is a similar one reported. Include closed issues as it may have been closed with a solution.
Next, create a new issue explaining the bug or feature.
PRs are welcome! Before submitting a one, however, please create an issue that explains the bug or feature request and that you plan on creating a pull request for it. If an issue already exists, please comment on that issue if you would like to submit a pull request for it.
All Pull Requests should be made to the develop branch.
- Fork the repo.
- Clone your fork.
- Make a branch for your change.
- Run
npm install(make sure you have node and npm installed first)
Tests are still being setup. This will be updated.
Demos are still being setup. This will be updated.
Please follow the following commit message format.
(scope): subject
An example is: (refactor) remove duplicate code
Must be one of the following:
- fix: A bug fix
- feat: A new feature
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- do not capitalize first letter
- do not place a period (.) at the end
- entire length of the commit message must not go over 50 characters
By contributing your code to this GitHub Repository, you agree to license your contribution under the MIT license.