Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (28 loc) · 780 Bytes

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 780 Bytes

Contributing to Harness

Thanks for contributing.

Development Setup

  1. Install Rust 1.75+.
  2. Clone the repository.
  3. Build the workspace:
cargo build
  1. Run tests before opening a PR:
cargo test

Pull Request Guidelines

  1. Keep PRs focused and small when possible.
  2. Include clear problem statement and scope in the PR description.
  3. Add or update tests for behavior changes.
  4. Update docs (README.md, docs/, command help text) when interfaces change.
  5. Ensure CI checks pass.

Commit Style

  • Use imperative commit messages.
  • Prefer one logical change per commit.

Reporting Bugs

Open a GitHub issue with:

  • expected behavior
  • actual behavior
  • reproduction steps
  • environment details (OS, Rust version, command used)