agentleFS
Sign inStart free
bherbruckbherbruck/solidcraft/AGENTS.md

solidcraft

AGENTS.md15k starsChanged 18 days agoApache-2.0View on GitHub

SolidCraft 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.

1 other project uses a version of this.

Adopted by

Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data

Week of Sep 13: 0 new projectsWeek of Sep 20: 0 new projectsWeek of Sep 27: 0 new projectsWeek of Oct 4: 0 new projectsWeek of Oct 11: 0 new projectsWeek of Oct 18: 0 new projectsWeek of Oct 25: 0 new projectsWeek of Nov 1: 0 new projects
Sep 2026Oct 2026Nov 2026
New projects taking a version of this file each week, over the 8 weeks our latest run read: only 0 in all, so this is a hint, not a trend.

Most recently taken up by

Who's talking about bherbruck/solidcraft

The biggest 5 of 75 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 75

Talked about on GitHub, YouTube, Bluesky and Hacker News (75 times).

On GitHub · 46

41 more on GitHub

On YouTube · 23

18 more on YouTube

On Bluesky · 5

On Hacker News · 1

The file

We split this AGENTS.md into the rules it gives an agent

5 rules. About 0 are common, 0 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    No GPL/LGPL/AGPL code, not even reading it (OpenCASCADE, FreeCAD, SolveSpace, CadQuery, LibreCAD, QCAD): cargo xtask licences --check.

    line 10
  2. Very specific:

    Every asset is original or openly licensed with a row in ATTRIBUTION.md.

    line 11
  3. Very specific:

    Never crash: no unwrap/expect/panic/unsafe in non-test code, errors are Result, input is hostile: clippy -D warnings, …

    line 12
  4. Very specific:

    Look at open PRs first, claim with a draft PR (lowest number wins), one topic per PR: skills/solidcraft-contributing/SKILL.md.

    line 26
  5. Very specific:

    Run cargo xtask ci before every commit.

    line 31

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

SolidCraft: instructions for agents

SolidCraft 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/solidcraft-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.md before 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.txt only 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/solidcraft-commands/SKILL.md.
  • Layering (geom, sketch/kernel/render, doc, io, engine, ui-egui, apps); only crates/kernel uses 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 SolidCraft; the old name lives only in docs/compatibility.md.
  • Sorted lists (message catalogs, mod lines, 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.txt only shrinks): skills/solidcraft-commands/SKILL.md.
  • New UI strings go in assets/locales/pending/<slug>.json, ATTRIBUTION rows in attribution/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/solidcraft-contributing/SKILL.md.
  • A PR's title and first sentence make sense to someone who never saw your chat or the issue: skills/solidcraft-contributing/SKILL.md.
  • Code, comments, commit messages and docs are in English, always: skills/solidcraft-contributing/SKILL.md ("Working as an agent").
  • Independent work runs in parallel, dependent work stays sequential: skills/solidcraft-contributing/SKILL.md ("Working as an agent").
  • Show observable changes with real screenshots or a recording, captured yourself.
  • Run cargo xtask ci before every commit. cargo xtask skills keeps this file and skills/ honest.

Working on X: read the skill first

Working onRead
A PR, a claim, review, CI or evidenceskills/solidcraft-contributing/SKILL.md
Licences, assets, clean-room, the nameskills/solidcraft-ground-rules/SKILL.md
Non-test Rust, hostile input, a crash reportskills/solidcraft-crash-safety/SKILL.md
A command, a crate boundaryskills/solidcraft-commands/SKILL.md
A dialog, panel, camera, icon, colourskills/solidcraft-ui/SKILL.md
Labels, messages, translationsskills/solidcraft-ui-text/SKILL.md
Saving something new in a design, import, exportskills/solidcraft-file-formats/SKILL.md
Preferences, a changed defaultskills/solidcraft-preferences/SKILL.md
Writing or running testsskills/solidcraft-tests/SKILL.md
Slow work, the window thread, wasmskills/solidcraft-performance/SKILL.md
Releases, installers, packagesskills/solidcraft-packaging/SKILL.md
Running the app, control channel, MCP toolsskills/solidcraft-agent-tools/SKILL.md
Building a part over MCPskills/solidcraft-modeling/SKILL.md
Changing an existing designskills/solidcraft-editing/SKILL.md
A bug report, a crash, a wrong resultskills/solidcraft-reporting/SKILL.md
Checking, porting, designs in gitskills/solidcraft-checking/SKILL.md
Assemblies, joints, motionskills/solidcraft-mechanisms/SKILL.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free