Skip to content

Commit 8a344b0

Browse files
committed
docs: add TOPOLOGY.md
1 parent f371053 commit 8a344b0

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 — a2ml-pre-commit
4+
5+
## Purpose
6+
7+
Pre-commit hook for validating `.a2ml` manifest files before commit. Checks SPDX headers, required identity fields, version presence, and attestation block structure. Integrates with the standard pre-commit framework.
8+
9+
## Module Map
10+
11+
```
12+
a2ml-pre-commit/
13+
├── hooks/
14+
│ └── validate-a2ml.sh # Main validation script
15+
├── examples/ # Example .a2ml 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-a2ml.sh] ──► [pass/fail]
24+
25+
[.a2ml files in repo]
26+
```

0 commit comments

Comments
 (0)