mirror of
https://github.com/bherbruck/solidcraft.git
synced 2026-11-19 07:01:00 +00:00
17c161bd5e
* Contributor docs: one rule for rebasing, force-pushing and who merges; kernel PRs target this repository - PR template, CONTRIBUTING.md and the contributing skill now agree: rebase onto the latest main, never merge main into a pull request, and push your own branch with --force-with-lease; never force-push main or a branch someone else works on. - Who merges: once CI passes, a maintainer (or the maintainer bot) marks the PR ready to merge and adds it to the merge queue. The skill no longer tells contributors to run gh pr merge, which needs write access. - solidcore/AGENTS.md: pull requests go to tangency-labs/solidcraft; tangency-labs/solidcore is a read-only mirror. - AGENTS.md: the full path of crates/engine/src/schema/unconverted.txt (line shortened to keep the router under 5000 characters). Fixes #15044 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SdcgEtwSrdwZxqTQp5MfnU * Contributor docs: allow rebase or merge of main, automation queues PRs, kernel rules, drawings branch, UI screenshots Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Brennen Herbruck <brennen.herbruck@gmail.com>
4.9 KiB
4.9 KiB
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.
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.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. - Everything is a command and programmatic calls never open dialogs:
skills/solidcraft-commands/SKILL.md. - Layering; only
crates/kerneluses truck; solidcore only viasolidcore-ops/-tess/-record(xtask/solidcore-seam.txt):cargo xtask layers; seedocs/layers.md. - 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 in
docs/compatibility.md. - 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 I/O schemas (soon required;
crates/engine/src/schema/unconverted.txtonly shrinks):skills/solidcraft-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 (existing UI, not kernel results) keeps the old behaviour behind a preference; fill the PR's
Changes a default:line. - 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; 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 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/solidcraft-contributing/SKILL.md |
| Licences, assets, clean-room, the name | skills/solidcraft-ground-rules/SKILL.md |
| Non-test Rust, hostile input, a crash report | skills/solidcraft-crash-safety/SKILL.md |
| A command, a crate boundary | skills/solidcraft-commands/SKILL.md |
| SolidCraft or solidcore, kernel, geometry | skills/solidcraft-layers/SKILL.md |
| A dialog, panel, camera, icon, colour | skills/solidcraft-ui/SKILL.md |
| Sheet metal | skills/solidcraft-sheetmetal/SKILL.md |
| Labels, messages, translations | skills/solidcraft-ui-text/SKILL.md |
| Saving something new in a design, import, export | skills/solidcraft-file-formats/SKILL.md |
| Preferences, a changed default | skills/solidcraft-preferences/SKILL.md |
| Writing or running tests | skills/solidcraft-tests/SKILL.md |
| Slow work, the window thread, wasm | skills/solidcraft-performance/SKILL.md |
| Releases, installers, packages | skills/solidcraft-packaging/SKILL.md |
| Running the app, control channel, MCP tools | skills/solidcraft-agent-tools/SKILL.md |
| Building a part over MCP | skills/solidcraft-modeling/SKILL.md |
| Changing an existing design | skills/solidcraft-editing/SKILL.md |
| A bug report, a crash, a wrong result | skills/solidcraft-reporting/SKILL.md |
| Checking, porting, designs in git | skills/solidcraft-checking/SKILL.md |
| Assemblies, joints, motion | skills/solidcraft-mechanisms/SKILL.md |