|
| 1 | +# SPDX-License-Identifier: MPL-2.0 |
| 2 | +# Adjustfile — Drift-tolerance contract for rsr-template-repo |
| 3 | +# Author: Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk> |
| 4 | +# |
| 5 | +# Cumulative-drift catchment: tolerance bands + corrective actions. |
| 6 | +# Authority: advisory (Yard) — continue-with-warnings; auto_fix where deterministic. |
| 7 | +# Run with: adjust check |
| 8 | +# Fix with: adjust fix (applies deterministic patches; advisory otherwise) |
| 9 | + |
| 10 | +@abstract: |
| 11 | +Drift tolerances and corrective actions for rsr-template-repo. Unlike |
| 12 | +MUST (hard gate), ADJUST tracks cumulative drift against tolerance bands |
| 13 | +and proposes corrective actions. Advisory — it warns and trends, it does |
| 14 | +not block. |
| 15 | +@end |
| 16 | + |
| 17 | +## Template Drift |
| 18 | + |
| 19 | +### placeholder-drift |
| 20 | +- description: Template placeholders should be replaced when copied |
| 21 | +- tolerance: 0 placeholder markers in copied repos |
| 22 | +- corrective: Search and replace all {{PLACEHOLDER}} markers |
| 23 | +- severity: advisory |
| 24 | +- notes: This check only applies to repos that copied from this template |
| 25 | + |
| 26 | +### template-version-drift |
| 27 | +- description: Template version should match RSR spec version |
| 28 | +- tolerance: Template version matches current RSR spec |
| 29 | +- corrective: Update template to match latest RSR spec |
| 30 | +- severity: advisory |
| 31 | + |
| 32 | +## Documentation Drift |
| 33 | + |
| 34 | +### readme-completeness |
| 35 | +- description: README should document all template features |
| 36 | +- tolerance: README covers all contractiles and directory structure |
| 37 | +- corrective: Update README.adoc with missing sections |
| 38 | +- severity: advisory |
| 39 | + |
| 40 | +### example-accuracy |
| 41 | +- description: Examples in documentation should match actual template content |
| 42 | +- tolerance: All code examples in docs are accurate |
| 43 | +- corrective: Audit and fix examples in documentation |
| 44 | +- severity: advisory |
| 45 | + |
| 46 | +## Structural Drift |
| 47 | + |
| 48 | +### contractile-sync |
| 49 | +- description: All contractiles should have matching a2ml and ncl implementations |
| 50 | +- tolerance: Every .a2ml has a corresponding .ncl |
| 51 | +- corrective: Generate missing .ncl files from .a2ml |
| 52 | +- severity: advisory |
| 53 | + |
| 54 | +### no-broken-symlinks |
| 55 | +- description: No broken symbolic links in template structure |
| 56 | +- tolerance: 0 broken symlinks |
| 57 | +- corrective: Run symlink-check script |
| 58 | +- severity: advisory |
| 59 | + |
| 60 | +## Accessibility Drift |
| 61 | + |
| 62 | +### adoc-not-md |
| 63 | +- description: Template docs should prefer AsciiDoc |
| 64 | +- tolerance: New prose docs are *.adoc |
| 65 | +- corrective: Convert any new *.md to *.adoc |
| 66 | +- severity: advisory |
| 67 | + |
| 68 | +### spdx-header-consistency |
| 69 | +- description: All template files have correct SPDX headers |
| 70 | +- tolerance: 0 files missing SPDX-License-Identifier |
| 71 | +- corrective: Add SPDX headers to files that need them |
| 72 | +- severity: advisory |
0 commit comments