Skip to content

copilot-instructions.md

Latest commit

 

History

History
57 lines (40 loc) · 1.55 KB

copilot-instructions.md

File metadata and controls

57 lines (40 loc) · 1.55 KB

Copilot Instructions

Before Writing Code

  • Read 0-AI-MANIFEST.a2ml in the repo root for canonical file locations.
  • State files (.a2ml) live in .machine_readable/ ONLY, never the root.

License

  • SPDX: MPL-2.0 on all new files.
  • Never use AGPL-3.0.
  • Copyright: Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>

Code Style

  • Use descriptive variable names.
  • Annotate and document all files.
  • Add SPDX header to every source file.
  • Use just for build/test/lint commands.

Banned Patterns

  • Idris2: no believe_me, no assert_total
  • Haskell: no unsafeCoerce, no unsafePerformIO
  • OCaml: no Obj.magic
  • Coq: no Admitted
  • Lean: no sorry
  • Rust: no transmute unless FFI with // SAFETY: comment

Banned Languages

  • No TypeScript (use ReScript)
  • No Node.js / npm / bun (use Deno)
  • No Go (use Rust)
  • No Python (use Julia or Rust)

Containers

  • Use Podman, never Docker.
  • Name the file Containerfile, never Dockerfile.
  • Base image: cgr.dev/chainguard/wolfi-base:latest.

ABI/FFI

  • ABI definitions in Idris2 (src/interface/abi/).
  • FFI implementations in Zig (src/interface/ffi/).
  • Generated C headers in src/interface/generated/.

State Files

Never create these in the repo root: STATE.a2ml, META.a2ml, ECOSYSTEM.a2ml, AGENTIC.a2ml, NEUROSYM.a2ml, PLAYBOOK.a2ml. They belong in .machine_readable/ only.