Skip to content

Commit

Permalink
chore: add git hooks setup command
Browse files Browse the repository at this point in the history
  • Loading branch information
ygrishajev committed Apr 22, 2024
1 parent 868d61a commit df59bb0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,12 @@ Our project enforces high standards of code quality and consistency to ensure th

- **Continuous Integration**: Our CI workflows are designed to validate pull requests and manage releases. They perform multiple checks including commit validation, linting, and testing code coverage before merging changes.

To better follow the above guidelines, we recommend using git hooks that would run the necessary checks before pushing your code. To do so after dependencies are installed, run the following command:

```bash
npm run setup-git-hooks
```

### Contributing

PRs are welcome! By adhering to these guidelines and leveraging our automated systems, we can maintain a high-quality codebase and streamline our development processes. We appreciate your contributions to making this project even better!
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@
"lint": "eslint . --ext .js,.ts,.json -c .eslintrc.json",
"lint:fix": "npm run lint -- --fix",
"prepublishOnly": "npm run build:production",
"setup-git-hooks": "husky",
"test": "npm run test:unit",
"test:cov": "jest --selectProjects unit functional --coverage",
"test:unit": "tap --ts tests/test_*.ts && jest --selectProjects unit",
Expand Down

0 comments on commit df59bb0

Please sign in to comment.