From 495be3d06bf6e7ab6320be7fa459f107c1769bde Mon Sep 17 00:00:00 2001 From: FrankMaverick Date: Fri, 12 Jul 2024 17:26:06 +0200 Subject: [PATCH] docs: Add note about optional pre-commit validations --- README.en.md | 2 ++ README.md | 5 +++++ 2 files changed, 7 insertions(+) diff --git a/README.en.md b/README.en.md index 6623c14..1181285 100644 --- 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 index 15ced15..11257f6 100644 --- 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