Thanks for being interested in contributing!
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
- Use a clear and descriptive title.
- Include as much information as possible: Steps to reproduce the issue, error message, Node.js version, operating system, etc.
- The more time you put into an issue, the more we will.
- (optional) The best issue report is a failing test proving it.
- Submit a comment to the relevant issue or create a new issue describing your proposed change.
- Do a fork, develop and test your code changes.
- We are creating a changelog for our releases and have a clear layout for commit / pr messages see below
- Include documentation. We are auto-generating our components API based on jsDocs so please follow the instructions at How to document components
- Submit a pull request
You'll get feedback about your pull request as soon as possible.
As we are generating changelogs based on successfully merged pull-requests we have to enforce a specific layout for git commit messages.
The general layout of commit messages should be <type>(<component(s)>): <message>
patches:
git commit -a -m "fix(header): Fixed broken styling"features:
git commit -a -m "feat(dropdown): Added icons to dropdown items"other changes:
You decide, e.g., docs, chore, etc.
git commit -a -m "docs(component): fixed up the docs a bit"