Thanks for your interest. This repository follows the Hyperpolymath estate standards defined in hyperpolymath/standards.
This project is licensed under MPL-2.0. By contributing you agree that
your contributions are licensed under the same terms. Every source file
carries an SPDX-License-Identifier header; keep it when editing, and add
one to any new file.
Use the toolchain declared by this repository (just).
This repo uses just (the estate uses Justfiles,
never Makefiles). Recipes available here:
just # list recipes
just doctor # environment diagnosticsThis repo carries .machine_readable/ A2ML files (STATE.a2ml,
META.a2ml, ECOSYSTEM.a2ml, AGENTIC.a2ml, NEUROSYM.a2ml,
PLAYBOOK.a2ml). If your change alters project state, architecture, or
operational steps, update the corresponding file in the same PR — CI
validates them.
The estate restricts which languages may be used. In particular Python, Go,
TypeScript, ReScript, V-lang, Java/Kotlin, Swift and Makefiles are not
accepted in new code; AffineScript, Rust/SPARK, Zig, Deno, Gleam, Elixir,
Haskell, Idris2, Agda, Julia and OCaml are. CI enforces this, so check the
policy in hyperpolymath/standards before introducing a new language.
Docs are AsciiDoc (.adoc) by default, including README.adoc. The
GitHub-required community-health files stay Markdown: SECURITY.md,
CONTRIBUTING.md, CODE_OF_CONDUCT.md, CHANGELOG.md. Do not add a .md
duplicate of a doc that already exists as .adoc.
- Branch from
main— do not push tomaindirectly; branch protection requires review and passing checks. - Keep the change focused, and explain why in the PR body.
- Make sure governance CI is green. It checks documentation presence, packaging policy, secrets, licence consistency and workflow security.
- Security issues: follow
SECURITY.md— report privately, never in a public issue.