Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (65 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

98 lines (65 loc) · 2.09 KB

Contributing to ros-z

Thank you for your interest in contributing to ros-z!

Quick Start

# Clone and setup
git clone https://github.com/ZettaScaleLabs/ros-z.git
cd ros-z
nix develop  # or: install Rust via rustup

# Build and test
cargo build
cargo test

# Run all pre-submission checks
./scripts/check-local.sh

Development Setup

With Nix (Recommended):

nix develop
# or: direnv allow

Without Nix:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
cargo install mdbook

Pre-Submission Checks

Run before opening a PR:

./scripts/check-local.sh

This runs:

  • cargo fmt --check - formatting
  • cargo clippy --all-targets -- -D warnings - linting
  • cargo build - compilation
  • cargo test - tests
  • mdbook test book -L ./target/debug/deps - documentation

Code Style

  • Use cargo fmt for formatting
  • Fix all cargo clippy warnings
  • Follow conventional commits: feat:, fix:, docs:, refactor:, test:, chore:

Pull Request Workflow

For External Contributors

Please open PRs as DRAFT initially:

  1. Run ./scripts/check-local.sh locally
  2. Open PR as draft
  3. Mark "Ready for review" when all checks pass

This helps us manage CI workflow approvals.

For All Contributors

  • Write clear PR descriptions
  • Reference issues: Fixes #123 or Relates to #456
  • Keep PRs small and focused
  • Respond to review feedback promptly

Documentation

  • Examples live in crates/ros-z/examples/ as runnable programs
  • Book chapters reference examples via {{#include}}
  • Test documentation: mdbook serve book

See the book for detailed guides.

Getting Help

License

Contributions are licensed under the same license as the project (see LICENSE).

Thank you for contributing to ros-z! 🦀