Skip to content

Commit

Permalink
correct the methods of pre-commit checks
Browse files Browse the repository at this point in the history
  • Loading branch information
SmartLayer committed Sep 21, 2023
1 parent 0941a3f commit c2faeea
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,16 @@ Here's a snapshot of our directory structure and their respective roles:
## For Contributors:
To avoid commit errors, consider creating a `.git/hooks/pre-commit` with:
Assuming using Linux or OS X, to avoid commit errors, consider creating a `.git/hooks/pre-commit` with:
```
#!/bin/sh
dita --project config/tokenscript-docsite.yaml --project config/smartlayer-docsite.yaml
dita --project config/tokenscript-docsite.yaml
dita --project config/smartlayer-docsite.yaml
```
Then make it executable.
This isn't added to the git repo due to potential variations in `dita` executable locations and system differences.
## Sysops:
Expand Down

0 comments on commit c2faeea

Please sign in to comment.