From 12c98d929e47b7a3210c30c35f5cf9485db636db Mon Sep 17 00:00:00 2001 From: Manish Maharjan <112875432+mmaharjan-ccdc@users.noreply.github.com> Date: Tue, 1 Sep 2026 11:51:28 +0100 Subject: [PATCH] NO_JIRA readme update --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 13a9432..57dfda4 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,19 @@ Developers can customise the licence header hook using Git configuration (use `- git config --global hooks.licenceCheckMode check # read-only check (warns/fails if headers are missing) ``` +### Supported and Excluded Files + +When licence header validation/formatting is enabled, files are filtered using the following rules: + +* **Included File Extensions:** + * **Hash style comments (`#`):** `.py`, `.sh`, `.bash`, `.yaml`, `.yml` + * **Slash style comments (`//`):** `.js`, `.ts`, `.cs`, `.cpp`, `.cxx`, `.cc`, `.h`, `.hpp` +* **Ignored Directories:** + * `.git`, `.github`, `test`, `tests`, `templates`, `bin`, `obj`, `packages`, `node_modules`, `dist`, `build`, `.venv`, `venv`, `__pycache__` +* **Ignored Suffixes & Generated Files:** + * Suffixes: `.designer.cs`, `.g.cs`, `.min.js`, `.lock` + * Any file containing `.generated.` in its name + ## Recommended settings ### To ensure the line endings are correctly converted: 1. On Windows: `git config --global core.autocrlf true`