Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (36 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.12 KB

Contributing to Saguaro Code Review

Thank you for your interest in contributing!

Development Setup

# Clone the repo
git clone https://github.com/mesa-dot-dev/saguaro.git
cd saguaro

# Install dependencies (requires Bun)
bun install

# Run tests
bun test

# Type check
bun run typecheck

# Lint (auto-fix)
bun run lint

# Build
bun run build

Making Changes

  1. Fork the repo and create a branch from main
  2. Make your changes
  3. Add or update tests as needed
  4. Run bun test and bun run lint to verify
  5. Open a pull request

Writing Rules

See docs/writing-rules.md for guidance on writing effective review rules.

Code Style

This project uses Biome for linting and formatting. Run bun run lint to auto-fix issues.

Reporting Bugs

Open an issue at github.com/mesa-dot-dev/saguaro/issues with:

  • Steps to reproduce
  • Expected vs actual behavior
  • sag --version output
  • OS and Node.js/Bun version

License

By contributing, you agree that your contributions will be licensed under the Apache-2.0 license.