|
| 1 | +// SPDX-License-Identifier: PMPL-1.0-or-later |
| 2 | += Required Repository Files |
| 3 | + |
| 4 | +The following files *MUST* be present and kept up-to-date in every repository: |
| 5 | + |
| 6 | +== Mandatory Dotfiles |
| 7 | + |
| 8 | +[cols="2,3"] |
| 9 | +|=== |
| 10 | +| File | Purpose |
| 11 | + |
| 12 | +| `.gitignore` | Exclude build artifacts, secrets, and temp files |
| 13 | +| `.gitattributes` | Enforce LF line endings and diff settings |
| 14 | +| `.editorconfig` | Consistent editor settings across IDEs |
| 15 | +| `.tool-versions` | asdf version pinning for reproducible builds |
| 16 | +|=== |
| 17 | + |
| 18 | +== Mandatory A2ML Files |
| 19 | + |
| 20 | +[NOTE] |
| 21 | +==== |
| 22 | +These files use the `.a2ml` extension. Earlier versions of this doc |
| 23 | +listed them as `.scm`; that was stale drift. `.scm` is reserved exclusively |
| 24 | +for Guix-related files (`guix.scm`, `.guix-channel`). All 6a2 metadata |
| 25 | +files use `.a2ml`. |
| 26 | +==== |
| 27 | + |
| 28 | +[cols="2,3"] |
| 29 | +|=== |
| 30 | +| File | Purpose |
| 31 | + |
| 32 | +| `META.a2ml` | Architecture decisions, development practices |
| 33 | +| `STATE.a2ml` | Project state, phase, milestones |
| 34 | +| `ECOSYSTEM.a2ml` | Ecosystem positioning, related projects |
| 35 | +| `PLAYBOOK.a2ml` | Executable plans, procedures |
| 36 | +| `AGENTIC.a2ml` | AI agent operational gating |
| 37 | +| `NEUROSYM.a2ml` | Symbolic semantics, proof obligations |
| 38 | +|=== |
| 39 | + |
| 40 | +== Build System |
| 41 | + |
| 42 | +[cols="2,3"] |
| 43 | +|=== |
| 44 | +| File | Purpose |
| 45 | + |
| 46 | +| `justfile` | Task runner (replaces Makefile) |
| 47 | +| `Mustfile` | Deployment state contract |
| 48 | +|=== |
| 49 | + |
| 50 | +*IMPORTANT*: Makefiles are FORBIDDEN. Use `just` for all tasks. |
| 51 | + |
| 52 | +== Validation |
| 53 | + |
| 54 | +These files are checked by: |
| 55 | + |
| 56 | +* CI workflow validation |
| 57 | +* Pre-commit hooks (when configured) |
| 58 | +* Repository standardization scripts |
| 59 | + |
| 60 | +== Updates |
| 61 | + |
| 62 | +When updating these files: |
| 63 | + |
| 64 | +. Use templates from `rsr-template-repo` as reference |
| 65 | +. Ensure SPDX license header is present |
| 66 | +. Test changes locally before pushing |
| 67 | +. Keep language-specific sections relevant to the repo |
| 68 | + |
| 69 | +== See Also |
| 70 | + |
| 71 | +* link:https://github.com/hyperpolymath/rhodium-standard-repositories[RSR (Rhodium Standard Repositories)] |
| 72 | +* link:https://github.com/hyperpolymath/mustfile[Mustfile Specification] |
| 73 | +* link:https://github.com/hyperpolymath/standards/tree/main/meta-a2ml[A2ML Format Family] |
0 commit comments