Contributing
Workflow #
- Create your branch from master
- Run
yarn
to setup the development environment. - Make the changes you want and test them out in the demo website before sending a pull request.
- Add all necessary information and examples in your pull request.
Commit message convention #
We follow conventional commits convention β¨
The commit contains the following structural elements, to communicate intent to the consumers of your library:
- fix: patches a bug in your codebase
- feat: introduces a new feature to the codebase
- BREAKING CHANGE: introduces a breaking API change
- refactor: introduce code refactor
- docs: changes into documentation
- test: adding or updating tests
- chore: tooling changes, chore changes
We have a pre-commit hook to verify if your commit is correct π
Writing components #
Each component will consist of:
ComponentName
: Folder with name of component (PascalCase)index.js
: The React componentindex.test.js
: Jest / react-testing-library tests for this componentstyles.js
: Any relatedstyled-components
utils.js
: utils for this component
Adding icons #
Check the Icon README
Reporting issues #
You can report issues on our github project π
Previous
InstallationNext
Upgrade