agentleFS
Sign inStart free
bherbruckbherbruck/solidcraft/skills/solidcraft-ground-rules/SKILL.md

solidcraft-ground-rules

Skill15k starsChanged 18 days agoApache-2.0View on GitHub

Use before adding any dependency, icon, image, font, test reference data or product wording to SolidCraft, 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.

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 skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Never copy another product's code, icons, artwork, help text, tooltips, templates or materials.

    line 12
  2. Distinctive:

    Do not drive, script, automate or extract data from commercial CAD products (Fusion, SolidWorks, Onshape, ...) for this project: no test …

    line 14
  3. Distinctive:

    Do not read, copy or link OpenCASCADE, FreeCAD (including planegcs), SolveSpace, CadQuery/OCP, LibreCAD or QCAD.

    line 18
  4. Very specific:

    Every file asset is original or openly licensed and has a row in ATTRIBUTION.md.

    line 25
  5. Very specific:

    Before any icon, icon assignment or media edit, read assets/AGENTS.md, assets/icons/ui/AGENTS.md and assets/icons/ui/STYLE_GUIDE.md.

    line 27

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill 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
SKILL.md

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

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

  • SolidCraft everywhere: crates solidcraft-*, binaries solidcraft and solidcraft-cli, .sc designs (.solidcraft still opens), the solidcraft/N format tag, SOLIDCRAFT_* environment variables, settings and recovery folders, the MCP server name, docs, CI and packaging.
  • The old name survives only in the compatibility shims listed in docs/compatibility.md. Do not add new uses of it.
  • Public docs, web and Flatpak deployments use project Pages /solidcraft/. Do not add permanent old-name Pages aliases.
  • 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.

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