cleanup precommit hooks (#3616)
Co-authored-by: Suchintan <suchintan@users.noreply.github.com>
This commit is contained in:
@@ -172,16 +172,21 @@ Updating, improving and correcting the documentation
|
||||
## Styleguides
|
||||
|
||||
### Pre Commit Hooks
|
||||
Make sure to run the pre-commit hooks before committing your code.
|
||||
This will help you to automatically format your code and catch cicd failures early.
|
||||
Make sure to install and run the pre-commit hooks before committing your code.
|
||||
This will help you to automatically format your code and catch CI/CD failures early.
|
||||
```bash
|
||||
# Make sure `pre-commit` is installed
|
||||
pip install pre-commit
|
||||
|
||||
# Run pre-commit hooks on files in your commit
|
||||
# Install the git hook scripts (one-time setup)
|
||||
pre-commit install
|
||||
|
||||
# (Optional) Run pre-commit hooks manually on all files
|
||||
pre-commit run --all-files
|
||||
```
|
||||
|
||||
Once installed, the hooks will run automatically on `git commit`.
|
||||
|
||||
### Commit Messages
|
||||
<!-- TODO
|
||||
|
||||
|
||||
Reference in New Issue
Block a user