Improve notes about git-hooks in the CONTRIBUTING.md doc

ddnexus · Jun 4, 2024 · 62f5563 · 62f5563
1 parent 1bed382
commit 62f5563
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -11,6 +11,7 @@ Here are a few useful information for contributors:
    the [locales  readme instructions here](https://github.com/ddnexus/pagy/blob/master/gem/locales/README.md).
 3. **Pagy repo setup**
     - Clone pagy: `git clone https://github.com/ddnexus/pagy && cd pagy`
+    - [Configure the git-hooks](https://github.com/ddnexus/pagy/tree/master/scripts/hooks)
 4. **Development**
     - Please create your own branch out of `master` and use it for you development and PR
     - Ensure you are basing your PR on the `master` branch and keep rebasing it on `master` when it changes

diff --git a/scripts/hooks/README.md b/scripts/hooks/README.md
@@ -8,7 +8,7 @@ See also the brief description inside the hook file.
 
 ### Symlink
 
-Symlink the hook into the `.git/hooks` dir:
+If your system support symlinks: symlink the hook into the `.git/hooks` dir:
 
 ```shell
 # from the repo root