mirror of
https://github.com/storytold/craft-anything.git
synced 2026-11-05 20:47:45 +01:00
Brandon Thomas
f64ae3bf3c
A native, pure-Rust app that shows anyone how a piece of software works, with evidence-backed answers, then helps them rebuild it. It ships a desktop app, a CLI and an MCP server, all driven by one engine. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1.5 KiB
1.5 KiB
Contributing
Thanks for helping. The rules every change follows (people and AI agents alike) are in AGENTS.md; the mistakes they come from are in docs/pitfalls.md. In short:
- Pick work from docs/ROADMAP.md (
cargo xtask pendinglists what's open). Claim it first: add— claimed: <your name>, branch <branch>to its line and open a draft PR, so nobody else does the same work. - One change per PR, on a branch named
feature/,bugfix/,docs/,test/,refactor/orchore/plus the roadmap id (feature/r1.4-provider-key-ui). PRs are squash-merged, so the title is the commit message: plain English, what changed for the person or developer. - Where things go: docs/extending.md (tools, target kinds, checks, coding agents, engines, plugins).
- Never crash, safe Rust only, every external program through
craft_anything_platform::process, no secrets or personal data anywhere. Everything is our own work: no code, names or wording copied from other projects.
Before you ask for review:
cargo fmt --all
cargo test -p <crates you touched>
cargo clippy -p <crates> --all-targets -- -D warnings
cargo xtask layers
cargo xtask secrets
Enable the secret-scan hook once per clone: git config core.hooksPath .githooks.
Code is dual-licensed under MIT or Apache-2.0 (LICENSE-MIT, LICENSE-APACHE); by contributing you agree your work is licensed the same way.