CONTRIBUTING.md

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

npm scripts

# install dependencies
$ npm i
# run tests
$ npm test
# run the code linter
$ npm run lint
# Build the lib
$ npm run build

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
$ npm test

Style

Style and lint errors should be fixed with

$ npm run lint

Contributors

@JellyBellyDev
@simonecorsi
@dnlup
@antoniomuso