Skip to content

Commit 3e110c6

Browse files
committed
docs: add TOPOLOGY.md
1 parent 08f6bb6 commit 3e110c6

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

TOPOLOGY.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- SPDX-License-Identifier: PMPL-1.0-or-later -->
2+
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
3+
# TOPOLOGY.md — k9-pre-commit
4+
5+
## Purpose
6+
7+
Pre-commit hook for validating `.k9` and `.k9.ncl` contractile files before commit. Enforces the K9! magic number, required field presence, and security-tier constraints. Integrates with the standard pre-commit framework.
8+
9+
## Module Map
10+
11+
```
12+
k9-pre-commit/
13+
├── hooks/
14+
│ └── validate-k9.sh # Main validation script
15+
├── examples/ # Example .k9 files (pass/fail)
16+
├── docs/ # Usage documentation
17+
└── .pre-commit-hooks.yaml
18+
```
19+
20+
## Data Flow
21+
22+
```
23+
[git commit] ──► [pre-commit framework] ──► [validate-k9.sh] ──► [pass/fail]
24+
25+
[.k9 / .k9.ncl files in repo]
26+
```

0 commit comments

Comments
 (0)