50 lines (34 loc) · 941 Bytes

Contributing

Setup

nix develop

Before Opening a PR

Run:

nix flake check
cargo fmt --all --check
./scripts/lint-shell.sh
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace

Or run the CI-parity script:

scripts/ci-check.sh

For decompiler behavior changes, validate with real binaries using:

scripts/real-golden.sh
scripts/real-golden-matrix.sh

Commit Style

Use atomic commits with format:

type(scope): description

Examples:

feat(decompiler): map internal selector to stdlib name
docs(readability): update selector mapping docs
ci(workflows): add pull request rust checks

PR Expectations

include tests for behavior changes
keep user docs and development docs updated
avoid mixing unrelated refactors with feature changes
use the repository PR template checklist
use issue templates for bug reports and feature requests