Skip to content

Commit 90f4e30

Browse files
committed
Minor README update
1 parent ca567a8 commit 90f4e30

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,10 @@ pip3 install -r requirements.txt
162162

163163
### Set up Git hooks
164164

165+
The `pre-push` git hook should be installed to avoid **project-specific** validation functions (which should be defined and stored under `esdlvalidator/validation/functions/projects/`) from being pushed to an open GitHub repository.
166+
167+
This does not affect when pushing changes to the internal gitlab repository (both project-specific functions and generic functions can be pushed to remotes).
168+
165169
At the project root, run the command in a bash terminal to set up git hooks.
166170

167171
```bash
@@ -175,7 +179,7 @@ Setting up Git hooks...
175179
✅ Git hook installed: .git/hooks/pre-push
176180
```
177181

178-
The reason for setting up this git hook (`pre-push`) is to block project-specific functions defined under `esdlvalidator/validation/functions/projects/` from being pushed to an open GitHub repository. This does not affect when pushing to the internal gitlab repository.
182+
179183

180184
### Testing
181185

0 commit comments

Comments
 (0)