Skip to content

QUICKSTART-DEV.adoc

Latest commit

 

History

History
73 lines (54 loc) · 2.79 KB

QUICKSTART-DEV.adoc

File metadata and controls

73 lines (54 loc) · 2.79 KB
Raw

nextgen-languages — Contributor Quick Start

Table of Contents

What you are working on

This is a documentation, registry, and governance coordinator. It contains no language build workspace. Do not expect just build to compile a language: implementations and their detailed specs, proofs, and tutorials live in their canonical repositories.

Set up

git clone https://github.com/hyperpolymath/nextgen-languages.git
cd nextgen-languages

For a reproducible shell, use the repository’s Guix manifest when Guix is available:

guix shell -m manifest.scm

There is no setup-dev recipe. For the checks below, Bash and Git are sufficient; just is optional shorthand.

Validate the coordinator

bash hooks/validate-language-registry.sh
bash hooks/validate-coordinator-boundary.sh

The first check compares the human pointers with the machine registry and other cross-reference surfaces. The second prevents language implementation material from being added here.

With just installed, the same baseline is available through:

just validate
just test
just check

test and check are checks of this coordinator, not of any language implementation. Run the owning language repository’s tests for language changes.

Repository map

  • languages/ — thin, human-readable pointers to canonical repositories.

  • .machine_readable/LANGUAGES.a2ml — scoped portfolio registry.

  • .machine_readable/descriptiles/ECOSYSTEM.a2ml — ecosystem references.

  • TOOLING-STATUS.adoc, language-status-tracker.jl — cross-project status surfaces.

  • docs/ecosystem-map.adoc — languages, syntax surfaces, substrates, tools, and teaching projects, clearly distinguished.

  • wiki/ — portfolio-level BerryWiki-compatible navigation; not per-language documentation.

  • extraction-queue/ — historical material pending confirmation that it has landed in canonical repositories; not canonical language source.

Before submitting

  1. Follow .github/CONTRIBUTING.md and GOVERNANCE.adoc.

  2. Keep status claims dated and evidence-scoped; do not turn TBD into a grade.

  3. For an actual registry member addition, update all registry surfaces together.

  4. Run both registry and boundary checks and review git diff --check.

  5. Keep private-repository names and details within their declared visibility policy.

More context