Files
likang 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
优化skill
2026-11-16 11:32:34 +08:00

3.5 KiB

name, description
name description
makecad-ground-rules Use before adding any dependency, icon, image, font, test reference data or product wording to makeCAD, or when unsure whether something may be copied, read or named. Covers independence from other CAD products, GPL code, asset attribution and the product name.

Independence, licences, assets and the name

The rules that cannot be broken in a PR. AGENTS.md lists them in one line each; the reasons are in CONTRIBUTING.md, "Rules that aren't negotiable".

Independent

  • Behaviour comes from public documentation, general CAD conventions and user feedback. File formats come from public specifications.
  • Never copy another product's code, icons, artwork, help text, tooltips, templates or materials.
  • Reference tests use analytic values (tools/oracle-analytic/) or open-source tools. Expected values never come from a commercial CAD product.
  • Do not drive, script, automate or extract data from commercial CAD products (Fusion, SolidWorks, Onshape, ...) for this project: no test data, measurements, command lists, ids or files produced with them.
  • Command ids are our own: dotted, lower-case <area>.<thing>[.<variant>], never another product's id.

No GPL, LGPL or AGPL code

  • Do not read, copy or link OpenCASCADE, FreeCAD (including planegcs), SolveSpace, CadQuery/OCP, LibreCAD or QCAD. Do not even read their sources.
  • tools/freecad-oracle/ runs FreeCAD as a separate program through its public scripting API to compute reference values. Nothing from FreeCAD is linked, vendored or shipped. The sketch solver and the blend operations are our own.
  • Permissive dependencies are fine: say which one you add and why in the PR. THIRD-PARTY-LICENSES.txt is regenerated on main; never edit it in a PR (cargo xtask licences --check only reports).
  • Code adapted from other permissive projects (MIT OR Apache-2.0) is noted in ATTRIBUTION.md. Projects published by storytold can serve as references for implementation conventions.

Assets: the most serious rule

  • makeCAD contains no iconography, images, fonts or artwork from commercial CAD products, ever. Screenshots of commercial CAD software are never committed.
  • Every file asset is original or openly licensed and has a row in ATTRIBUTION.md. cargo xtask assets enforces it.
  • Command icons are the original SVG masters in assets/icons/ui/design/svg/, compiled through crates/ui-egui/src/icon_svg.rs.
  • Before any icon, icon assignment or media edit, read assets/AGENTS.md, assets/icons/ui/AGENTS.md and assets/icons/ui/STYLE_GUIDE.md. Use the canonical bases and named finished references there; never invent a parallel icon style. cargo xtask icons validates them.

The name

  • Product-facing prose, assistant replies and skill names use makeCAD (makecad-*). Do not introduce the previous display name.
  • Existing crate and binary names (solidcraft-*, solidcraft, solidcraft-cli), .sc/.solidcraft designs, the solidcraft/N format tag, SOLIDCRAFT_* environment variables, settings paths and MCP bridge ids remain technical compatibility identifiers. Do not rename them as a wording change or break existing designs and integrations.
  • Upstream repository URLs and licence attribution remain accurate. Deployment paths follow the host configuration.
  • Labels, parameter docs, messages and docs use the terms in the glossary (docs/book/src/reference/glossary.md): one term for each idea. A change that adds a new idea adds its term there.
  • Units are millimetres and radians internally; Z is up.