For consistency we make use of Conventional Commits. It's encouraged that commit messaging follow the format
<type>[optional scope]: <description>
To set up your work environment you'll need to use
- NodeJS
- And if you plan on making container contributions you may want to setup
- Docker or
- Podman, Homebrew can be used for the install
$ brew install podman
, Easy setup directions here
To start work
$ npm install
$ npm run start:dev
Jest is used for the unit test framework. To run unit tests during development open a terminal instance and run
$ npm run test:dev
This should also let you update the code snapshots.
The requirements for code coverage are currently maintained around the 60%
to 70%
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
$ npm test
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