Skip to content

Commit

Permalink
Add about pre-commit.ci to user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
amrit110 committed Apr 29, 2024
1 parent 9de34a1 commit c238119
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/source/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,14 @@ the typos hook and only run it occasionally on the entire codebase.
```

### pre-commit ci

Instead of fixing pre-commit errors manually, a CI to fix them as well as update
pre-commit hooks periodically can be enabled for your repository. Please check
[pre-commit.ci](https://pre-commit.ci/) and add your repository. The configuration for
``pre-commit.ci`` can be added to the ``.pre-commit-config.yaml`` file.


## documentation

If your project doesn't have documentation, copy the directory named `docs` to the root
Expand Down

0 comments on commit c238119

Please sign in to comment.