Skip to content

Commit

Permalink
Mention new format & lint checks setup
Browse files Browse the repository at this point in the history
  • Loading branch information
paescuj committed Jun 21, 2022
1 parent 3ec5da0 commit 089b762
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,21 @@ updated.

# Maintaining

## Code Format & Linting

Code format and lint checks are performed locally when committing to ensure the changes align with the configured rules of this repository. This happens with the help of the tools [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) and [lint-staged](https://github.com/okonet/lint-staged) which are automatically installed and configured on `npm install` (no further steps required).

In case of problems, a corresponding message is displayed in your terminal.
Please fix them and then run the commit command again.

## Test

Tests can be run with command:
Tests can be run with the command:

```bash
npm test
```

## Release

Use [np](https://www.npmjs.com/package/np) to create a new release
Use [np](https://www.npmjs.com/package/np) to create a new release.

0 comments on commit 089b762

Please sign in to comment.