Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions .meta/REQUIRED-FILES.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
// SPDX-License-Identifier: PMPL-1.0-or-later
= Required Repository Files

The following files *MUST* be present and kept up-to-date in every repository:

== Mandatory Dotfiles

[cols="2,3"]
|===
| File | Purpose

| `.gitignore` | Exclude build artifacts, secrets, and temp files
| `.gitattributes` | Enforce LF line endings and diff settings
| `.editorconfig` | Consistent editor settings across IDEs
| `.tool-versions` | asdf version pinning for reproducible builds
|===

== Mandatory A2ML Files

[NOTE]
====
These files use the `.a2ml` extension. Earlier versions of this doc
listed them as `.scm`; that was stale drift. `.scm` is reserved exclusively
for Guix-related files (`guix.scm`, `.guix-channel`). All 6a2 metadata
files use `.a2ml`.
====

[cols="2,3"]
|===
| File | Purpose

| `META.a2ml` | Architecture decisions, development practices
| `STATE.a2ml` | Project state, phase, milestones
| `ECOSYSTEM.a2ml` | Ecosystem positioning, related projects
| `PLAYBOOK.a2ml` | Executable plans, procedures
| `AGENTIC.a2ml` | AI agent operational gating
| `NEUROSYM.a2ml` | Symbolic semantics, proof obligations
|===

== Build System

[cols="2,3"]
|===
| File | Purpose

| `justfile` | Task runner (replaces Makefile)
| `Mustfile` | Deployment state contract
|===

*IMPORTANT*: Makefiles are FORBIDDEN. Use `just` for all tasks.

== Validation

These files are checked by:

* CI workflow validation
* Pre-commit hooks (when configured)
* Repository standardization scripts

== Updates

When updating these files:

. Use templates from `rsr-template-repo` as reference
. Ensure SPDX license header is present
. Test changes locally before pushing
. Keep language-specific sections relevant to the repo

== See Also

* link:https://github.com/hyperpolymath/rhodium-standard-repositories[RSR (Rhodium Standard Repositories)]
* link:https://github.com/hyperpolymath/mustfile[Mustfile Specification]
* link:https://github.com/hyperpolymath/standards/tree/main/meta-a2ml[A2ML Format Family]
53 changes: 0 additions & 53 deletions .meta/REQUIRED-FILES.md

This file was deleted.

2 changes: 1 addition & 1 deletion component-readiness-grades/SELF-ASSESSMENT.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Assessed: 2026-04-04

|**D (RSR-Compliant)**
|PASSED
|RSR scaffolding complete: LICENSE, SECURITY.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, MAINTAINERS.adoc, 19 CI workflows, .machine_readable/, 0-AI-MANIFEST.a2ml, Justfile/Mustfile
|RSR scaffolding complete: LICENSE, SECURITY.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, MAINTAINERS.adoc, RSR-required CI workflows (per `hypatia-rules/rsr-self-compliance.a2ml @required_workflows`) + adopted optional set, .machine_readable/, 0-AI-MANIFEST.a2ml, Justfile/Mustfile

|**C (Self-Validated)**
|PASSED
Expand Down
4 changes: 2 additions & 2 deletions immaculate-guide/IMMACULATE-GUIDE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ fi
=== rsr-template-repo as Canonical Start

Every new repository MUST start from `rsr-template-repo`, not from scratch.
This ensures the 17 required workflows, the `.machine_readable/` directory,
This ensures the RSR-required workflows (per `hypatia-rules/rsr-self-compliance.a2ml @required_workflows` — currently 4 mandated, plus the broader adoptable set), the `.machine_readable/` directory,
and the `justfile` scaffold are present from day one.

[source,bash]
Expand Down Expand Up @@ -264,7 +264,7 @@ before every merge._

=== The Hyperpolymath CI Stack

Every repo uses the 17 required workflows from `rsr-template-repo`.
Every repo uses the RSR workflows from `rsr-template-repo` — 4 mandated by `hypatia-rules/rsr-self-compliance.a2ml @required_workflows` (`hypatia-scan.yml`, `mirror.yml`, `scorecard.yml`, `rsr-antipattern.yml`), plus the broader optional adoptable set.
The three that act as truth validators are:

[source,bash]
Expand Down
2 changes: 1 addition & 1 deletion toolchain-readiness-grades/SELF-ASSESSMENT.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The next non-trivial promotion. Requires:
is now at `templates/CANONICAL-PROOF-SUITE.adoc` (v1.0, 15 entries).
. *2 fully-proven programs* per §6.2, each cross-validated by at
least one qualifying prover from `templates/QUALIFYING-PROVERS.adoc`.
. *RSR-FULL* — all 17 RSR workflows present, SHA-pinned, and currently
. *RSR-FULL* — all RSR-required workflows (per `hypatia-rules/rsr-self-compliance.a2ml @required_workflows`) plus the broader adopted set present, SHA-pinned, and currently
green. Standards repo is RSR-compliant; need to verify the same for
the host repo of the audited component.
. *Banned constructs ZERO* — verified by `panic-attack assail` clean
Expand Down
2 changes: 1 addition & 1 deletion toolchain-readiness-grades/TOOLCHAIN-READINESS-GRADES.a2ml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
(stability-posture "not-yet-releasable")
(ordinal 3)
(description "All Must + Should + Canonical Proof Suite. RSR-FULL. panic-attack zero across all severities. Fuzzing harness exists. 2 fully-proven programs.")
(evidence-required "all E + canonical M/S/E proof suite passing + RSR-FULL all 17 workflows green + panic-attack zero all severities + fuzz harness exists + 2 fully-proven programs each by >=1 qualifying prover")
(evidence-required "all E + canonical M/S/E proof suite passing + RSR-FULL all required workflows green (per hypatia-rules/rsr-self-compliance.a2ml @required_workflows) + panic-attack zero all severities + fuzz harness exists + 2 fully-proven programs each by >=1 qualifying prover")
(minimum-for #f))
(grade
(code C)
Expand Down
4 changes: 2 additions & 2 deletions toolchain-readiness-grades/TOOLCHAIN-READINESS-GRADES.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ NOTE: D is *not* the alpha gate. Alpha begins at C. D is the

[horizontal]
Tier gate:: All *Must* AND all *Should* rows PASSED.
Repository discipline:: RSR-FULLY-compliant — all 17 RSR workflows present,
Repository discipline:: RSR-FULLY-compliant — all RSR-required workflows (per `hypatia-rules/rsr-self-compliance.a2ml @required_workflows`) plus the broader adopted set present,
SHA-pinned, and *currently green*. (Promoted from B to D because
a toolchain component without RSR-full is just an unaudited binary
in disguise.) All grade-E requirements carried forward.
Expand Down Expand Up @@ -440,7 +440,7 @@ estate standard at the time of assessment. Specifically and without
exception:

[horizontal]
RSR:: All 17 RSR workflows present, SHA-pinned, and *green for at least
RSR:: All RSR-required workflows (per `hypatia-rules/rsr-self-compliance.a2ml @required_workflows`) plus the broader adopted set present, SHA-pinned, and *green for at least
90 consecutive days*. Zero workflow flakes in that window.
Branch protection:: per `feedback_branch_protection.md` —
PR-required, signatures-required, linear history,
Expand Down
Loading