# Contributing

## Commits
We make use of [Conventional Commits](https://www.conventionalcommits.org). It's encouraged that 
commit messaging follow the format
  ```
  <type>[optional scope]: <description>
  ```

### Build Requirements
To set up your work environment you'll need to use
 * [NodeJS](https://nodejs.org/)
 * NPM
   > There appear to be dependency mapping issues with `Yarn` v1.x.x lock files, `Typescript` and `webpack`, and specific dependencies
   > using ES modules. If you do decide to use [Yarn](https://yarnpkg.com) use the latest version.
    
### Develop with testing
To start work
  ```shell
  $ npm
  $ npm run test:dev
  ```

#### Testing
Jest is used for the unit test framework. To run unit tests during development open a terminal instance and run
  ```shell
  $ npm run test:dev
  ```

### Code Coverage
The requirements for code coverage are currently maintained around the `60%` to `80%` mark.

Updates that drop coverage below the current threshold should have their coverage expanded before being merged. 

Settings for coverage can be found in [package.json](./package.json)

#### To check test coverage
  ```shell
  $ npm test
  ```

#### Code coverage failing to update?
If you're having trouble getting an accurate code coverage report, or it's failing to provide updated results (i.e. you renamed files) you can try running
  ```
  $ npm run test:clearCache
  ```