Contributing
March 28, 2024 ยท View on GitHub
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'feat(scope): some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
yarn scripts
# install dependencies
$ yarn
# run tests
$ yarn test
# run the code linter
$ yarn style:lint
# Build the lib
$ yarn build
# Test UI locally with mocked data
$ yarn start
Commit Convention
This projects uses commitlint with Angular configuration so be sure to use standard commit format or PR won't be accepted
Quality
Contributions should be validated with the command:
$ codeclimate analyze
See codeclimate.
Test
Contributions should pass existing tests or have test cases for new functionality.
# Should pass
$ yarn test
Style
Style and lint errors should be fixed with
$ yarn style:lint
Contributors
@JellyBellyDev @simonecorsi @dnlup @antoniomuso @sergeyshevch