Skip to content

Commit 7d55f6c

Browse files
authored
add documentation
1 parent 85d331d commit 7d55f6c

1 file changed

Lines changed: 24 additions & 2 deletions

File tree

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,31 @@ Pre-commit hooks for PCDS projects (https://pre-commit.com/)
1010

1111
### To install pre-commit hooks to a local repository:
1212

13-
If .pre-config-config.yaml does not already exist in the repository, copy
13+
If `.pre-config-config.yaml` does not already exist in the repository, copy
1414
the appropriate file from this repository to the top-level of your local
15-
repository and commit the addition.
15+
repository, or add the folowing to an existing `.pre-config-config.yaml`
16+
file and commit the addition.
17+
18+
```yaml
19+
repos:
20+
- repo: https://github.com/pre-commit/pre-commit-hooks.git
21+
rev: v2.5.0
22+
hooks:
23+
- id: no-commit-to-branch
24+
- id: trailing-whitespace
25+
files: \.(TcPOU|TcDUT|TcGVL)$
26+
27+
- repo: https://github.com/pcdshub/pre-commit-hooks.git
28+
rev: v1.4.0
29+
hooks:
30+
- id: twincat-leading-tabs-remover
31+
- id: twincat-lineids-remover
32+
- id: twincat-xml-format
33+
- id: check-fixed-library-versions
34+
- id: no-product-version
35+
# Optional, if you use pytmc to generate EPICS IOCs:
36+
# - id: pytmc-pragma-linter
37+
```
1638

1739
Once the file is there, run the following from inside your repository:
1840
```bash

0 commit comments

Comments
 (0)