Angular South African Form Validators

Please note that this is the README for contributors, if you need instructions on how to consume this package, please take a look here.

A set of South African specific validators for Angular forms.

Getting Started🏁

1. Clone the repo.

2. Navigate to projects/rh-rsa-form-validators

3. Run npm install.

4. Create a feature or bugfix branch.

5. Make your changes.

6. Ensure that your changes are of good quality.

7. Commit your changes and submit a PR to merge your changes into main.

NPM Scripts📜

To check eslint, run command npm run lint.

To check unit tests, run command npm run test.

Contribute🌳

Ensure you work out of the project itself (projects/rh-rsa-form-validators) and not the Angular workspace

Always make the code better, if you see errors, please fix them.

Add tests and try to move the code coverage up to 90%.

Update the usage documentation.

Bump the version number according to semantic versioning.

Only the classes and models exported in public-api.ts will be exposed through the package.