Skip to content

QUICKSTART-DEV.adoc

Latest commit

 

History

History
119 lines (90 loc) · 3.15 KB

QUICKSTART-DEV.adoc

File metadata and controls

119 lines (90 loc) · 3.15 KB
Raw

standards — Quick Start for Developers

Table of Contents
Note
 Working on the standards themselves. Canonical entry points: README.adoc (human) and 0-AI-MANIFEST.a2ml (agent).

Tech Stack

The product is the specs (AsciiDoc + A2ML). The code is reference implementations and language bindings that prove them:

  • Rust/SPARK — a2ml/bindings/rust, 1-formats/k9/bindings/rust

  • Deno — protocol reference impls (axel-protocol, 2-protocols/0-ai-gatekeeper/mcp-repo-guardian)

  • Zig — FFI/reference targets

  • AsciiDoc / A2ML — the specs, templates, and machine-readable metadata

Language + licence policy is binding: .claude/CLAUDE.md.

Set Up Development Environment

Option A: Guix

guix shell

Option B: Manual

git clone https://github.com/hyperpolymath/standards.git
cd standards
just --list

Build

just build          # builds the Rust/Zig sub-project artefacts

Test

just test           # runs every sub-project test suite

Project Structure

standards/
├── README.adoc           # Human front door (routing table)
├── 0-AI-MANIFEST.a2ml    # Machine front door (agent entry)
├── REGISTRY.adoc         # Notice: registry machinery retired 2026-10-09
├── a2ml/  1-formats/k9/  *-a2ml/   # Foundation specs (Stream 1)
├── *-protocol/           # Protocol specs
├── *-readiness-grades/   # ARG / FRG / CRG / TRG frameworks
├── hypatia-rules/        # Dogfooding rules
├── .machine_readable/    # State (descriptiles/), contractiles
├── Justfile              # Task runner recipes
├── guix.scm             # Guix reproducible environment
└── .github/workflows/    # Enforcement CI

Key Recipes

just build          # Build the project
just test           # Run tests
just doctor         # Self-diagnostic
just lint           # Lint and format
just assail         # Security scan via panic-attacker
just tour           # Guided tour of the codebase

Before Submitting a PR

just lint           # Format and lint
just test           # All tests pass
just assail         # No new security issues

Contractile Invariants

Read .machine_readable/MUST.contractile before making changes. Key invariants that must never be violated:

  • A2ML state files live in .machine_readable/descriptiles/ only — never the repo root.

  • No Makefiles (use Justfile); SPDX header on every source file.

  • Licence/SPDX is Manual-Only for agents — flag drift, never edit it.

LLM/AI Agent Development

If using an AI assistant, load the warmup context first:

just llm-context    # Outputs role-appropriate context

Or read 0-AI-MANIFEST.a2ml and .claude/CLAUDE.md directly.

Get Help