Docs/Project

Project

Contributing

How to work on Aura — RFCs, corpus, compiler, and site.

Aura is developed in the open under the MIT license.

Where to contribute

AreaPathNotes
Language / designdocs/rfc/Copy TEMPLATE.md; statuses are controlled
Compiler / CLIcrates/Rust workspace; tests via cargo test --workspace
Runtimeruntime/aura_rt.cLinked into native builds
Std packagesstd/io, assert, collections, …
Executable examplescorpus/Preferred proof for features
User docsdocs/guide/This site’s /docs content
Websitesite/Vite + React; pnpm site:dev

Design process

  1. RFC for non-trivial language or toolchain changes
  2. Corpus sample when behavior is user-visible
  3. Compiler / runtime implementation with tests
  4. User guide update when the feature is teachable

Read RFC-000 for principles. Use the RFC catalog and dependency graph to see how documents block each other.

Local checks

bash
cargo test --workspace
cargo run -p aura-cli -- check corpus/hello/main.aura
pnpm install          # once, from repo root (site workspace package)
pnpm site:test
pnpm site:build

CI (.github/workflows/ci.yml) runs the same gates on every PR and push to main: workspace tests, corpus check (excluding corpus/diag/), a few run/test smokes, plus site test + build.

Site production deploys via .github/workflows/deploy-site.yml to Cloudflare Pages (https://aura.fadosoft.com). See site/README.md.

Communication

  • Issues and PRs on GitHub
  • Keep user docs in English; identifiers match code

Next

All docs pages