Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
109 lines (77 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

109 lines (77 loc) · 2.83 KB

Contributing

Before starting work, choose the documentation track:

  • Legacy stack setup/runbook: docs/wap-test-environment/README.md
  • Browser emulator build track: docs/browser-emulator/README.md

Development setup

Quick bootstrap:

./scripts/init-refresh.sh

Canonical prerequisite reference:

  • docs/development-prerequisites.md
  1. Clone repository and install required tools:
    • Docker + Docker Compose
    • Node 20.19+ (or 22.12+). Repo pin: .nvmrc
    • pnpm 10+ (for Node workspace scripts)
    • Rust toolchain + wasm-pack (for engine-wasm)
    • pre-commit (for git hooks)
  2. Start legacy stack:
make up
make status
  1. Build WASM engine package:
cd engine-wasm/engine
wasm-pack build --target web --out-dir ../pkg
  1. Install git hooks:
make hooks-install

Hook behavior:

  • pre-commit hook runs lint-staged on staged files only:
    • Prettier for browser/frontend and engine-wasm/host-sample
    • rustfmt for staged Rust files in engine-wasm/engine, browser/src-tauri, and transport-rust
    • Frontend typecheck (pnpm --dir browser/frontend exec tsc --noEmit) when staged changes touch browser/contracts/* or browser/frontend/*
  • pre-push hook runs strict checks via pre-commit (rust fmt --check, cargo clippy -D warnings, cargo test where configured, and configured non-mutating checks).

Coding standards

  • Follow .editorconfig.
  • Keep cross-layer contracts synchronized with implementation changes.
  • Add/update docs for any setup, command, or interface change.

Testing

  • Legacy smoke test:
make smoke
  • WASM engine tests:
cd engine-wasm/engine
cargo test
  • Repo-wide CI-equivalent checks:
make ci-local

Node checks are disabled by default in make to avoid blocking environments without stable pnpm/corepack setup. Enable them explicitly when needed:

ENABLE_NODE_CHECKS=1 make ci-local

Pre-push node hooks are opt-in:

WAP_ENABLE_NODE_HOOKS=1 pre-commit run --all-files

Git Hooks and CI

  • Local hooks are wired from .githooks/ (git config core.hooksPath .githooks).
  • .githooks/pre-commit runs lint-staged and .githooks/pre-push runs .pre-commit-config.yaml checks.
  • CI runs in GitHub Actions:
    • .github/workflows/ci.yml (required PR/push checks)
    • .github/workflows/transport-wap-smoke.yml (manual WAP smoke against Kannel stack)
  • Branch protection required-check policy: docs/ci/REQUIRED_CHECKS.md
  • Some layer checks are intentionally disabled until those layers are bootstrapped:
    • electron-app lint/test/build
    • Node package lint/test scripts where not yet defined

Pull request checklist

  • Code builds/tests pass locally for touched components
  • Docs updated for setup/contract changes
  • No generated artifacts committed unless intentionally required