|
| 1 | +# Required Repository Files |
| 2 | + |
| 3 | +The following files **MUST** be present and kept up-to-date in every repository: |
| 4 | + |
| 5 | +## Mandatory Dotfiles |
| 6 | + |
| 7 | +| File | Purpose | |
| 8 | +|------|---------| |
| 9 | +| `.gitignore` | Exclude build artifacts, secrets, and temp files | |
| 10 | +| `.gitattributes` | Enforce LF line endings and diff settings | |
| 11 | +| `.editorconfig` | Consistent editor settings across IDEs | |
| 12 | +| `.tool-versions` | asdf version pinning for reproducible builds | |
| 13 | + |
| 14 | +## Mandatory SCM Files |
| 15 | + |
| 16 | +| File | Purpose | |
| 17 | +|------|---------| |
| 18 | +| `META.scm` | Architecture decisions, development practices | |
| 19 | +| `STATE.scm` | Project state, phase, milestones | |
| 20 | +| `ECOSYSTEM.scm` | Ecosystem positioning, related projects | |
| 21 | +| `PLAYBOOK.scm` | Executable plans, procedures | |
| 22 | +| `AGENTIC.scm` | AI agent operational gating | |
| 23 | +| `NEUROSYM.scm` | Symbolic semantics, proof obligations | |
| 24 | + |
| 25 | +## Build System |
| 26 | + |
| 27 | +| File | Purpose | |
| 28 | +|------|---------| |
| 29 | +| `justfile` | Task runner (replaces Makefile) | |
| 30 | +| `Mustfile` | Deployment state contract | |
| 31 | + |
| 32 | +**IMPORTANT**: Makefiles are FORBIDDEN. Use `just` for all tasks. |
| 33 | + |
| 34 | +## Validation |
| 35 | + |
| 36 | +These files are checked by: |
| 37 | +- CI workflow validation |
| 38 | +- Pre-commit hooks (when configured) |
| 39 | +- Repository standardization scripts |
| 40 | + |
| 41 | +## Updates |
| 42 | + |
| 43 | +When updating these files: |
| 44 | +1. Use templates from `rsr-template-repo` as reference |
| 45 | +2. Ensure SPDX license header is present |
| 46 | +3. Test changes locally before pushing |
| 47 | +4. Keep language-specific sections relevant to the repo |
| 48 | + |
| 49 | +## See Also |
| 50 | + |
| 51 | +- [RSR (Rhodium Standard Repositories)](https://github.com/hyperpolymath/rhodium-standard-repositories) |
| 52 | +- [Mustfile Specification](https://github.com/hyperpolymath/mustfile) |
| 53 | +- [SCM Format Family](https://github.com/hyperpolymath/meta-scm) |
0 commit comments