mirror of
https://github.com/instructkr/claw-code.git
synced 2026-04-03 17:34:48 +08:00
44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
# Contributing
|
|
|
|
Thanks for contributing to Claw Code.
|
|
|
|
## Development setup
|
|
|
|
- Install the stable Rust toolchain.
|
|
- Work from the repository root in this Rust workspace. If you started from the parent repo root, `cd rust/` first.
|
|
|
|
## Build
|
|
|
|
```bash
|
|
cargo build
|
|
cargo build --release
|
|
```
|
|
|
|
## Test and verify
|
|
|
|
Run the full Rust verification set before you open a pull request:
|
|
|
|
```bash
|
|
cargo fmt --all --check
|
|
cargo clippy --workspace --all-targets -- -D warnings
|
|
cargo check --workspace
|
|
cargo test --workspace
|
|
```
|
|
|
|
If you change behavior, add or update the relevant tests in the same pull request.
|
|
|
|
## Code style
|
|
|
|
- Follow the existing patterns in the touched crate instead of introducing a new style.
|
|
- Format code with `rustfmt`.
|
|
- Keep `clippy` clean for the workspace targets you changed.
|
|
- Prefer focused diffs over drive-by refactors.
|
|
|
|
## Pull requests
|
|
|
|
- Branch from `main`.
|
|
- Keep each pull request scoped to one clear change.
|
|
- Explain the motivation, the implementation summary, and the verification you ran.
|
|
- Make sure local checks pass before requesting review.
|
|
- If review feedback changes behavior, rerun the relevant verification commands.
|