Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (46 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 2.17 KB
Raw

Contributing to gistui

Prerequisites

  • Rust (stable toolchain)
  • GitHub CLI (gh) installed and authenticated

Development Setup

git clone https://github.com/akunzai/gistui.git
cd gistui
cargo build

Run without a TTY to verify gh is ready:

cargo run -- --check

Verification Gate

All four must pass before every commit:

cargo fmt --check   # or: cargo fmt
cargo test
cargo check
cargo clippy --all-targets -- -D warnings

Building a release binary

cargo build --release

The optimized binary is target/release/gistui. It bundles no assets, but still requires the gh CLI on PATH at runtime (gh is not vendored). Optionally shrink it with strip target/release/gistui.

Architecture

Coding agents: read AGENTS.md first (index), then docs/agents/architecture.md for the deep-dive.

Key points:

  • Pure modules (domain, config, ranking, local, diff, actions planner/guard): unit-tested, no IO.
  • Thin IO boundaries (gh, actions execute helpers, tui::run_loop): not unit-tested by design.
  • AppState::handle_key is pure — it mutates state and returns a KeyOutcome; all IO runs in run_loop.
  • Tests must never call the real gh or the network. Fixtures live in tests/fixtures/gh/.

Submitting a PR

  1. Fork and create a branch (feat/my-feature or fix/issue-123).
  2. Keep commits focused; follow Conventional Commits (feat:, fix:, docs:, chore:).
  3. Open a PR against main; the CI gate must be green.
  4. Label the PR so it lands in the right release-note section (.github/release.yml): enhancement (🚀 Features), bug (🐛 Bug Fixes), documentation (📚 Documentation), dependencies (⬆️ Dependencies), or skip-changelog to omit it. Unlabeled PRs fall under "🧰 Maintenance".

Releasing

Maintainers: see RELEASING.md for the release and crates.io publish process.

Reporting Issues

Use the bug report or feature request templates.