Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (46 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

60 lines (46 loc) · 1.15 KB

Contributing to atlassian-cli

Quick Start

# Clone and build (automatically installs pre-commit hooks)
git clone https://github.com/omar16100/atlassian-cli
cd atlassian-cli
cargo build

Pre-commit Hooks

Hooks run automatically on git commit:

  • ✅ Code formatting (cargo fmt)
  • ✅ Linting (cargo clippy)
  • ✅ Unit tests

If hooks fail:

cargo fmt              # Fix formatting
cargo clippy --fix     # Fix linting
cargo test             # Run tests

Bypass hooks (for WIP commits only):

git commit --no-verify -m "WIP: work in progress"

Local Testing

make pre-commit   # Run all checks
make quick-check  # Format + clippy only
make test         # Tests only

Or using just:

just pre-commit   # Run all checks
just quick-check  # Format + clippy only
just test         # Tests only

CI Pipeline

All PRs must pass:

  1. Format check
  2. Clippy lints
  3. All tests (Linux + macOS)

Runs in ~60-90 seconds (parallel jobs).

Code Standards

  • Keep files around 2000 LOC (per CLAUDE.md)
  • Add unit tests for new features
  • Update todo.md with changes
  • Run cargo fmt before committing