Contributing
May 9, 2020 ยท View on GitHub
Development Environment
There is really not much too it. As long as you have some experience with:
- Lerna (there is a great tutorial repository ahmadawais/lerna-tutorial)
- Yarn Workspaces
After you fork this repository, all you have to do is run:
yarn install
Now you can party ๐๐ and do some work. ๐
Guidelines
Please, don't skip git hooks:
- we all have to use conventional commit messages for semantic release to work
- we all have to fix eslint errors before we commit new changes
Thank you for considering your help to this repository. ๐
Commit Guidelines
| Commit Type | Title | Description | Emoji | Release | Include in changelog |
|---|---|---|---|---|---|
feat | Features | A new feature | โจ | minor | true |
fix | Bug Fixes | A bug Fix | ๐ | patch | true |
docs | Documentation | Documentation only changes | ๐ | patch | true |
style | Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | ๐ | - | true |
refactor | Code Refactoring | A code change that neither fixes a bug nor adds a feature | ๐ฆ | - | true |
perf | Performance Improvements | A code change that improves performance | ๐ | patch | true |
test | Tests | Adding missing tests or correcting existing tests | ๐จ | - | true |
build | Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | ๐ | patch | true |
ci | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | โ๏ธ | - | true |
chore | Chores | Other changes that don't modify src or test files | โป๏ธ | patch | true |
revert | Reverts | Reverts a previous commit | ๐ | - | true |