920d5c6c3a
Add a repository-local pre-push gate that runs the locked Rust workspace build from the repo root, plus concise install and verification docs for maintainers. Constraint: ROADMAP #694 requires a local installable hook artifact only; branch protection remains external. Rejected: CI or branch-protection changes | outside the requested local pre-push gate scope. Confidence: high Scope-risk: narrow Directive: Keep .github/hooks/pre-push and contributor docs synchronized if the Rust workspace build command changes. Tested: bash -n .github/hooks/pre-push; SKIP_CLAW_PRE_PUSH_BUILD=1 .github/hooks/pre-push; git diff --check; python3 .github/scripts/check_doc_source_of_truth.py; cargo fmt --manifest-path rust/Cargo.toml --all -- --check; cargo build --manifest-path rust/Cargo.toml --workspace --locked; .github/hooks/pre-push Not-tested: shellcheck and markdownlint unavailable in environment.
2.4 KiB
Contributing to Claw Code
Thanks for helping improve Claw Code. This repository is a Rust-first CLI workspace with supporting docs and compatibility fixtures.
Ground rules
- Keep changes small, reviewable, and tied to a concrete issue or behavior.
- Do not commit secrets, API keys, session transcripts with credentials, or generated build output.
- Prefer existing crate boundaries and utilities before adding dependencies.
- Update documentation when a user-facing command, config key, or provider behavior changes.
- Keep examples copy/paste safe. Use placeholder keys such as
sk-ant-...and avoid commands that require live credentials unless the text explicitly says so.
Local setup
git clone https://github.com/ultraworkers/claw-code
cd claw-code/rust
cargo build --workspace
cargo test --workspace
On Windows PowerShell, build from the same rust workspace and run the binary
with the .exe suffix:
cd claw-code\rust
cargo build --workspace
.\target\debug\claw.exe --help
Local pre-push build gate
Install the repository-local hook to catch stale compile errors before pushing:
git config core.hooksPath .github/hooks
This sets the repo's Git hook directory to .github/hooks; if you already use a
custom core.hooksPath, copy or chain .github/hooks/pre-push instead. The hook
runs cargo build --manifest-path rust/Cargo.toml --workspace --locked from the
repository root. If you must bypass it for a non-code/docs-only push, set
SKIP_CLAW_PRE_PUSH_BUILD=1; the hook prints when that escape hatch is used.
Checks before opening a pull request
Run the smallest relevant tests for your change, then the broader checks when you touch shared runtime, CLI, or docs surfaces:
cd rust
cargo fmt --all --check
cargo test --workspace
cargo clippy --workspace
For documentation and release-readiness changes, also run:
python .github/scripts/check_doc_source_of_truth.py
python .github/scripts/check_release_readiness.py
Pull request guidance
- Describe the user-visible reason for the change.
- List the commands you ran and any known gaps.
- Call out compatibility risks for CLI output, JSON schemas, plugin contracts, provider behavior, or Windows/PowerShell examples.
- Keep unrelated cleanup out of feature or fix pull requests.
License
By contributing, you agree that your contributions are licensed under the project's MIT License.