678058c940
CI / Select checks (push) Has been cancelled
CI / Format and repository checks (push) Has been cancelled
CI / Compile RISC-V (manual) (push) Has been cancelled
Docker / image (push) Has been cancelled
Generated files / Regenerate and commit (push) Has been cancelled
Kernel rig / Select the rig areas (push) Has been cancelled
Lists / Design format changes merge cleanly (push) Has been cancelled
Lists / Lists are sorted one item per line (push) Has been cancelled
Packaging lint / lint (push) Has been cancelled
Pages / build (push) Has been cancelled
CI / Dependency advisories (push) Has been cancelled
CI / Quick compile (push) Has been cancelled
CI / Native Linux Clippy (push) Has been cancelled
CI / Build tests (push) Has been cancelled
CI / Native Linux tests (push) Has been cancelled
CI / GPU path tests (1/4) (push) Has been cancelled
CI / GPU path tests (2/4) (push) Has been cancelled
CI / GPU path tests (3/4) (push) Has been cancelled
CI / GPU path tests (4/4) (push) Has been cancelled
CI / Action matrix (1/16) (push) Has been cancelled
CI / Action matrix (10/16) (push) Has been cancelled
CI / Action matrix (11/16) (push) Has been cancelled
CI / Action matrix (12/16) (push) Has been cancelled
CI / Action matrix (13/16) (push) Has been cancelled
CI / Action matrix (14/16) (push) Has been cancelled
CI / Action matrix (15/16) (push) Has been cancelled
CI / Action matrix (16/16) (push) Has been cancelled
CI / Action matrix (2/16) (push) Has been cancelled
CI / Action matrix (3/16) (push) Has been cancelled
CI / Action matrix (4/16) (push) Has been cancelled
CI / Action matrix (5/16) (push) Has been cancelled
CI / Action matrix (6/16) (push) Has been cancelled
CI / Action matrix (7/16) (push) Has been cancelled
CI / Action matrix (8/16) (push) Has been cancelled
CI / Action matrix (9/16) (push) Has been cancelled
CI / Action matrix determinism (push) Has been cancelled
CI / Property tests (many cases) (push) Has been cancelled
CI / Doc tests (push) Has been cancelled
CI / Reference tests (push) Has been cancelled
CI / Windows D3D12 FXC shaders (push) Has been cancelled
CI / Windows app startup (push) Has been cancelled
CI / ci (push) Has been cancelled
CI / Compile WebAssembly (push) Has been cancelled
CI / Nightly alert (push) Has been cancelled
Kernel rig / Build the CLI (push) Has been cancelled
Kernel rig / Kernel rig (${{ matrix.shard }}) (push) Has been cancelled
Kernel rig / kernel-rig (push) Has been cancelled
Pages / deploy (push) Has been cancelled
4.8 KiB
4.8 KiB
makeCAD: instructions for agents
makeCAD is a clean-room, pure-Rust parametric 3D CAD app (sketch solver, feature timeline, B-rep kernel, an egui UI that agents drive). This file is a router: the hard rules, then the skill to read for your task. Humans: CONTRIBUTING.md.
Start here
Work: ROADMAP.md, "Where help is wanted most" in CONTRIBUTING.md, issues labelled help wanted, good first issue, needs-triage; architecture in docs/architecture.md. Local plan/ notes are optional.
Hard rules (what enforces each)
- Independent: never copy another product's code, icons, text or templates; never drive or take data from commercial CAD.
skills/makecad-ground-rules/SKILL.md. - No GPL/LGPL/AGPL code, not even reading it (OpenCASCADE, FreeCAD, SolveSpace, CadQuery, LibreCAD, QCAD):
cargo xtask licences --check. - Every asset is original or openly licensed with a row in ATTRIBUTION.md; read
assets/AGENTS.mdbefore icon work:cargo xtask assets,cargo xtask icons. - Never crash: no unwrap/expect/panic/unsafe in non-test code, errors are
Result, input is hostile: clippy-D warnings,hostile_params_never_panic. - Model decisions (what an operation does, which bodies it touches, which face or edge a point or name means, depths, nearness) use exact geometry; a mesh is for display, export, previews and mesh bodies (
xtask/mesh-decisions.txtonly shrinks):cargo xtask mesh-decisions. - New kernel cases go to solidcore:
cargo xtask lists. - Everything is a command and programmatic calls never open dialogs:
skills/makecad-commands/SKILL.md. - Layering (geom, sketch/kernel/render, doc, io, engine, ui-egui, apps); only
crates/kerneluses truck:cargo xtask layers. - One outer UI container, one camera path (
navigation::handle), colours from theme tokens:cargo xtask ui-containers. - Application code is Rust only and builds for wasm:
cargo xtask wasm,cargo xtask web-offline-test. - The product name is makeCAD. Existing crate, CLI, protocol and file-format identifiers remain compatible; new assistant skill identifiers use
makecad-*. - Sorted lists (message catalogs,
modlines, languages) stay sorted:cargo xtask lists. Never edit generated files (docs/features.md,THIRD-PARTY-LICENSES.txt) in a PR. - A design-format change is ONE new file in
crates/doc/src/format/pending/:scripts/test-format-pending.sh. - A command has input and output schemas (will become required;
schema/unconverted.txtonly shrinks):skills/makecad-commands/SKILL.md. - New UI strings go in
assets/locales/pending/<slug>.json, ATTRIBUTION rows inattribution/pending/<slug>.md:cargo xtask lists. - A changed default keeps the old behaviour behind a preference and fills the PR's
Changes a default:line:pr-checks.yml. - A regression test goes in the area's existing test file, never a per-bug file (#3226).
- Look at open PRs first, claim with a draft PR (lowest number wins), one topic per PR:
skills/makecad-contributing/SKILL.md. - A PR's title and first sentence make sense to someone who never saw your chat or the issue:
skills/makecad-contributing/SKILL.md. - Code, comments, commit messages and docs are in English, always:
skills/makecad-contributing/SKILL.md("Working as an agent"). - Independent work runs in parallel, dependent work stays sequential:
skills/makecad-contributing/SKILL.md("Working as an agent"). - Show observable changes with real screenshots or a recording, captured yourself.
- Run
cargo xtask cibefore every commit.cargo xtask skillskeeps this file andskills/honest.
Working on X: read the skill first
| Working on | Read |
|---|---|
| A PR, a claim, review, CI or evidence | skills/makecad-contributing/SKILL.md |
| Licences, assets, clean-room, the name | skills/makecad-ground-rules/SKILL.md |
| Non-test Rust, hostile input, a crash report | skills/makecad-crash-safety/SKILL.md |
| A command, a crate boundary | skills/makecad-commands/SKILL.md |
| A dialog, panel, camera, icon, colour | skills/makecad-ui/SKILL.md |
| Labels, messages, translations | skills/makecad-ui-text/SKILL.md |
| Saving something new in a design, import, export | skills/makecad-file-formats/SKILL.md |
| Preferences, a changed default | skills/makecad-preferences/SKILL.md |
| Writing or running tests | skills/makecad-tests/SKILL.md |
| Slow work, the window thread, wasm | skills/makecad-performance/SKILL.md |
| Releases, installers, packages | skills/makecad-packaging/SKILL.md |
| Running the app, control channel, MCP tools | skills/makecad-agent-tools/SKILL.md |
| Building a part over MCP | skills/makecad-modeling/SKILL.md |
| Changing an existing design | skills/makecad-editing/SKILL.md |
| A bug report, a crash, a wrong result | skills/makecad-reporting/SKILL.md |
| Checking, porting, designs in git | skills/makecad-checking/SKILL.md |
| Assemblies, joints, motion | skills/makecad-mechanisms/SKILL.md |