Skip to content

doc: rewrite CONTRIBUTING.md for Rust CLI - #14

Closed
deus-intus wants to merge 1 commit into
hanzoai:mainfrom
deus-intus:rewrite-contributing
Closed

deus-intus wants to merge 1 commit into
hanzoai:mainfrom
deus-intus:rewrite-contributing

Conversation

@deus-intus

Copy link
Copy Markdown

Fixes #12

Summary

Rewrites CONTRIBUTING.md to accurately reflect the Rust CLI codebase:

  • Removed obsolete Python setup instructions (venv, pip, requirements*.txt), code style tools (black, isort), and pytest.
  • Removed dead links to dev.chat and Dev-AI/dev.
  • Added Rust development workflows: cargo build, cargo test, and cargo clippy --bin hanzo.
  • Documented test structure: integration tests in tests/cli.rs with state isolated behind --config <tempdir>, unit tests beside code (src/commands/product/tests.rs), and how to run individual tests.
  • Streamlined PR and contribution guidelines.

Acceptance Criteria

  • grep -n -i -e pip -e pytest -e venv -e black -e isort -e Dev-AI -e dev.chat CONTRIBUTING.md prints nothing.
  • Every command in the file runs on a fresh clone of this repo.
  • Every URL in the file returns 200 (verified with curl -sIL).
  • The file is 84 lines (cleanly shorter than 241 lines previously).

Remove obsolete Python setup, dead Dev-AI/dev links, and pytest instructions.
Add cargo build, cargo test, and cargo clippy guidance matching README.md,
document test locations (tests/cli.rs, unit tests in src), and streamline PR process.

Fixes #12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rewrite CONTRIBUTING.md for the Rust CLI; it describes a Python app

2 participants