👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document.
Feel free to check issues page to find an enhancement to implement or bug to fix. You could also Improve the documentation, Report a Bug, or Suggest an Enhancement.
- Fork this repository and submit a pull request.
- Write tests
- Ensure the linter passes with
npm run lint - Ensure the tests pass at the CI Server by following the status of your pull request.
The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
The commit message should be structured as follows:
<type>[optional scope]: <description>
[optional body]
[optional footer]
The commit message formatting can be added using a typical git workflow or through the use of a CLI wizard (Commitizen).
If you're unsure of how to get the messages right, let us know and just do your best and we'll clean them up in the merge!