How to contribute
SketchCraft is free and open source. Here's how to help, whether you write code or not.
SketchCraft is built in the open on GitHub, under the MIT license. You don’t need to write code to make it better.
Without writing code
- Report a bug. Tell us what you did, what you expected and what happened, with your SketchCraft version and computer. Use the contact form or open an issue on GitHub.
- Ask for a feature. Suggest an idea. Coming from SketchUp and missing something? That’s the most useful thing you can tell us.
- Fix the help docs. Every help page has a “Tell us” link at the bottom.
- Write a plugin. Plugins are small JavaScript files that add commands, ask questions with forms, and build or measure geometry. Start with Writing a plugin, and look at the built-in Cut list and Shelves.
Found a security problem? Please don’t post it publicly: report it privately on GitHub.
With code
The engine is Rust, and the app is React and three.js in Tauri. You need Rust (the version in
rust-toolchain.toml) and Node.js 22.
1. Get it running
Fork the repository, clone your fork, then run the engine’s bridge and the app’s dev page:
cargo build --release && ./target/release/sketchcraft bridge # the engine, on 127.0.0.1:5175
cd app && npm ci && npm run dev # the app, on 127.0.0.1:5174
Open the app’s page in your browser and you’re developing SketchCraft. Building and running it covers the desktop build, and How the code is laid out is the map.
2. Pick something
3. Bring its tests
The one rule: a feature lands with its tests. A change that adds or changes behavior comes with the test that would have caught it going wrong.
| You changed | Add |
|---|---|
| A new tool | A scenario in tools/ui-tests/tools.mjs (the suite fails if a tool has none) |
| An engine command or importer | A Rust test in core/tests/ |
| Interface code (parsing, settings, skins) | A Vitest test in app/tests/ |
| How a screen looks | Updated visual references, after you’ve looked at them |
| A bug | A test that fails without your fix |
Run what you touched before you push:
cargo test --release -p sketchcraft-core # the engine
cd app && npm test && npm run check # the interface
node tools/ui-tests/run.mjs tools # the browser suites (needs Playwright)
Never run tests against your real models. The browser suites use a scratch folder of their own.
If you run the engine or a Rust test by hand, point SKETCHCRAFT_DOC and HOME at a scratch folder
first.
4. Open a pull request
- Branch from
developwith a short name likefeature/hatch-patternsorfix/flip-edge, and open your pull request againstdevelop. - Keep commits small, and say what changed and why.
- Don’t commit models,
.envfiles or anything from your home folder. - When CI is green it’s squash-merged.
The full guide, with every test suite and what CI checks, is CONTRIBUTING.md on GitHub.
By contributing, you agree your work is released under the MIT license.