ng-table/CONTRIBUTING.md

CONTRIBUTING
============

1. Fork the repo and clone locally
2. In locally cloned repo: `npm install && npm run setup`
    * This will the build fro the library and all the demo apps
3. Prove existing code:
    * Run the unit tests: `npm test`
    * Run the end-to-end tests (see section below)
4. Make changes in `src` folder
    * **Tip**: use `npm run test:w` to verify your changes on save
5. Add additional unit tests in `test` folder. These should cover your changes
6. *Optionally* add end-to-end tests in `e2e` folder
7. Prove changes:
    * Run the unit tests: `npm test`
    * Run the end-to-end tests (see section below)
8. Commit changes: `npm run cm`
    - why use **npm** and not **git** to commit? See "Conventional commit message" section below
9. Push your changes to your fork and submit a pull request


## Running end-to-end tests

* In one terminal window: `npm run e2e-server`
* In another terminal window: `npm run e2e`
    * **Tip**: use `npm run e2e-only` if you already have built source code (ie you've `npm run setup` or `npm run build:all`)


## Conventional commit message

This project uses the structure of the commit message to:

1. Generate release notes like you see in [this release](https://github.com/esvit/ng-table/releases/tag/v2.0.0)
2. Generate the next version number for the npm package using the rules of [semver](http://semver.org/) 
3. Trigger the publish a release of this library to npm using [semantic-release](https://github.com/semantic-release/semantic-release) 

These conventions are detailed here: [angular commit message conventions](https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md)

### Commitizen command line tool

To help you to follow these conventions this project uses [Commitizen](https://github.com/commitizen/cz-cli). 

Commitizen provides a command line tool that will help you create a commit message that matches these conventions.

To lauch this tool we use `npm run cm`.