Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

61 lines (44 loc) · 1.25 KB
Raw

Contributing

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'feat(scope): some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. 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