Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (49 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

66 lines (49 loc) · 2.53 KB

Contributing

Development Setup

  1. Install Rust 1.85 or newer.
  2. Clone the repository and fetch submodules if your workflow requires them.
  3. Build the workspace:
cargo check --workspace

Required Checks

Run these commands before opening a PR:

cargo fmt --all
cargo +1.85.0 check --workspace --all-targets --all-features --locked
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo audit
cargo check --workspace --examples
cargo check -p aelf-client --target wasm32-wasip2 --no-default-features
cargo check -p aelf-contract --target wasm32-wasip2 --no-default-features
cargo check -p aelf-sdk --target wasm32-wasip2 --no-default-features
cargo test --workspace

Optional live-node validation:

cargo test -p aelf-sdk --test local_node -- --ignored
cargo test -p aelf-sdk --test public_readonly_smoke -- --ignored --test-threads=1

cargo test --workspace intentionally excludes the ignored live smoke suites so the default test pass remains deterministic and offline-friendly.

Repository Layout

  • crates/aelf-sdk: public facade crate
  • crates/aelf-client: HTTP client, DTOs, transaction builder
  • crates/aelf-contract: typed and dynamic contract bindings
  • crates/aelf-crypto: wallet, signing, address utilities
  • crates/aelf-keystore: JS-compatible keystore support
  • crates/aelf-proto: generated protobuf bindings
  • crates/aelf-sdk/examples: canonical example sources
  • examples/: thin forwarding wrappers for local convenience

Pull Requests

  • Keep changes scoped to one problem or feature.
  • Add or update tests for every behavior change.
  • Document public API additions with rustdoc.
  • Update README.md, README.zh.md, or CHANGELOG.md when user-facing behavior changes.
  • Keep the documented MSRV at Rust 1.85 and preserve the hard cargo +1.85.0 check --workspace --all-targets --all-features --locked CI gate.
  • Preserve the wasm32-wasip2 compile gates for aelf-client, aelf-contract, and aelf-sdk when changing transport or feature-flag behavior.

Release Flow

  • Push a tag such as v0.1.0-alpha.1 to trigger the automated release flow.
  • The tag workflow runs release preflight checks first, then publishes the workspace crates in dependency order.
  • If a publish run partially succeeds, rerun the publish workflow manually with packages="aelf-contract,aelf-sdk"-style inputs and keep skip_published=true.

Commit Style

Use Conventional Commit / git-cz style messages in English and keep the matching emoji prefix used by the repository workflow.