|
| 1 | +# SPDX-License-Identifier: PMPL-1.0-or-later |
| 2 | +# Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <jonathan.jewell@open.ac.uk> |
| 3 | +# Authoritative source: docs/AI-CONVENTIONS.md |
| 4 | + |
| 5 | +# Read 0-AI-MANIFEST.a2ml in the repo root FIRST for canonical file locations. |
| 6 | + |
| 7 | +# LICENSE |
| 8 | +# All original code: PMPL-1.0-or-later (SPDX header required on every file). |
| 9 | +# Never use AGPL-3.0. Fallback to MPL-2.0 only when platform requires it. |
| 10 | +# Copyright: Jonathan D.A. Jewell (hyperpolymath) <jonathan.jewell@open.ac.uk> |
| 11 | + |
| 12 | +# STATE FILES |
| 13 | +# .a2ml metadata files go in .machine_readable/ ONLY. |
| 14 | +# Never create STATE.a2ml, META.a2ml, ECOSYSTEM.a2ml, AGENTIC.a2ml, |
| 15 | +# NEUROSYM.a2ml, or PLAYBOOK.a2ml in the repository root. |
| 16 | + |
| 17 | +# BANNED PATTERNS |
| 18 | +# Idris2: believe_me, assert_total, assert_smaller, unsafePerformIO |
| 19 | +# Haskell: unsafeCoerce, unsafePerformIO, undefined, error |
| 20 | +# OCaml: Obj.magic, Obj.repr, Obj.obj |
| 21 | +# Coq: Admitted |
| 22 | +# Lean: sorry |
| 23 | +# Rust: transmute (unless FFI with // SAFETY: comment) |
| 24 | + |
| 25 | +# BANNED LANGUAGES |
| 26 | +# TypeScript -> use ReScript |
| 27 | +# Node.js / npm / bun -> use Deno |
| 28 | +# Go -> use Rust |
| 29 | +# Python -> use Julia or Rust |
| 30 | + |
| 31 | +# CONTAINERS |
| 32 | +# Runtime: Podman (never Docker) |
| 33 | +# File: Containerfile (never Dockerfile) |
| 34 | +# Base: cgr.dev/chainguard/wolfi-base:latest |
| 35 | + |
| 36 | +# ABI/FFI STANDARD |
| 37 | +# ABI definitions: Idris2 with dependent types (src/abi/) |
| 38 | +# FFI implementation: Zig with C ABI (ffi/zig/) |
| 39 | +# Generated C headers: generated/abi/ |
| 40 | + |
| 41 | +# BUILD SYSTEM |
| 42 | +# Use just (justfile) for all build, test, lint, and format tasks. |
| 43 | + |
| 44 | +# CODE STYLE |
| 45 | +# Use descriptive variable names. |
| 46 | +# Annotate and document all files. |
| 47 | +# Add SPDX-License-Identifier header to every source file. |
0 commit comments