- Our style is based on prettier and the ESLint recommended rules, with some minor customizations. This is auto-enforced and can usually be applied by running
npm run fix
. - Commits must follow the Angular commit message guidelines. We use semantic-release to release versions to
npm
, update the changelog, etc. Following these guidelines is simplified by using the Commitizen CLI with thecz-conventional-changelog
adapter.
- You are welcome to submit an issue with a bug report or a feature request.
- If you are reporting a bug, please indicate which version of the package you are using and provide steps to reproduce the problem.
- If you are submitting a feature request, please indicate if you are willing or able to submit a PR for it.
If you want to contribute to the repository, follow these steps:
- Fork the repo.
- Verify that everything is working before you start developing:
npm test
- Make your changes. Please follow our style guidelines and leave comments where appropriate. Be sure to update all applicable files [1].
- Add one or more tests for your changes. Only refactoring, documentation, or build changes require no new tests.
- Once your tests are passing, commit changes with an appropriate commit message.
- Push to your fork and open a pull request. Describe your changes and the motivation for them.
[1] If submitting a new validation, the following files must be updated:
- src/.defaultsForValidator.js
- README.md (description of validation and documentation of default value)