Skip to content

NO_JIRA readme update #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mmaharjan-ccdc merged 1 commit into from
Sep 1, 2026
Merged

NO_JIRA readme update #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down