docs: Add note about optional pre-commit validations

teamdigitale · Jul 12, 2024 · 495be3d · 495be3d
1 parent 71fe113
commit 495be3d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.en.md b/README.en.md
@@ -50,6 +50,8 @@ To enable pre-commit checks in another repository,
 copy the [`.pre-commit-config.yaml`](.pre-commit-config.yaml) file 
 and the [`.github/workflows/validate.yaml`](.github/workflows/validate.yaml) file.
 
+Note: It is possible to comment on checks deemed unnecessary or inappropriate. For example, when using a solution with stable URIs, the validation check of the filename against the URIs (validate-filename-match-uri) may not be essential.
+
 ### URL Tests
 
 The `test_urls.py` script in the `tests` directory verifies 

diff --git a/README.md b/README.md
@@ -68,6 +68,11 @@ Inoltre, è possibile eseguirli manualmente in qualsiasi momento.
 Per abilitare i controlli pre-commit in un altro repository, 
 copiare il file [`.pre-commit-config.yaml`](.pre-commit-config.yaml) e il file [`.github/workflows/validate.yaml`](.github/workflows/validate.yaml).
 
+Nota: È possibile commentare i controlli ritenuti non necessari o inappropriati. 
+Ad esempio, se si utilizza una soluzione con URI stabili, 
+il controllo di validazione del nome del file 
+rispetto agli URI (`validate-filename-match-uri`) potrebbe non essere indispensabile.
+
 ### Test URL
 
 Lo script `test_urls.py` nella directory `tests` consente di verificare