Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (41 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 1.49 KB
Raw

Contributing to duodiff

Prerequisites

  • Rust (stable toolchain)
  • mise (optional, but highly recommended for task running)

Development Setup

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

Run TUI on two directories to try it out:

cargo run -- <left_dir_path> <right_dir_path>

Verification Gate

We use mise to enforce project formatting, lints, and test suites. Before submitting commits or PRs, run the following verification checks:

Using mise (Recommended):

mise run check

Or using native Cargo commands:

cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo test --locked
cargo check

Building a Release Binary

cargo build --release

The optimized binary is located at target/release/duodiff.

Architecture

See AGENTS.md for the full architecture guide, conventions, and rules.

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: enhancement (🚀 Features), bug (🐛 Bug Fixes), documentation (📚 Documentation), dependencies (⬆️ Dependencies), or skip-changelog.

Reporting Issues

Use GitHub Issues to report bugs or request new features.