CONTRIBUTING.md

Contributing to @ultimate/ngx-errors

All contributions are greatly appreciated.

Please make sure that any contribution you make has an issue for it, and that you link to the issue in your pull request. Before the pull request is merged the issue must have an approved label on it (this will be added if it's an approved feature/fix etc and needs to be done).

Submitting an issue

When you submit an issue, please keep to the pre-filled template, as it will help speed things along when your issue is addressed.

Make a change

To setup @ultimate/ngx-errors for development, run the following -

git clone git@github.com:UltimateAngular/ngx-errors.git
cd ngx-errors
yarn install
yarn example

This will start watching for changes to any source files, and compile/bundle the source. It'll spin up a local web server at http://localhost:3000 where you can test the library against an example form.

Committing and adding a PR

Once you're ready, commit your changes and submit your PR. All commits should follow these guidelines (to keep things neat).

Your PR should keep to the pre-filled template.