Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

73 lines (54 loc) · 2.79 KB

Contributing to taino-edit

Thanks for your interest! This is a solo-maintained project with a deliberately narrow v0.1 scope — please read DESIGN_NOTES.md and ROADMAP.md before opening non-trivial PRs. The roadmap's Deferred and Out of scope sections mark where community contributions are most welcome.

Prerequisites

  • Rust toolchain as pinned in rust-toolchain.toml (stable channel, MSRV 1.80). rustup will install it automatically.
  • The wasm32-unknown-unknown target (declared in the toolchain file).

Build & test

Every change must keep all four of these green — CI enforces them:

cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test --all-features
cargo doc --no-deps --all-features

The project is publishable at every checkpoint, so also keep cargo publish --dry-run succeeding for each crate.

Browser tests (taino-edit-dom)

The DOM bridge in taino-edit-dom is exercised against a real headless Chromium via wasm-bindgen-test. The pipeline needs a small local patch on wasm-bindgen-cli (see vendor/) plus Chrome for Testing in .tools/. Two helper scripts make this reproducible on Linux:

./scripts/install-wasm-test-runner.sh   # one-time: patch & install wasm-bindgen-cli
./scripts/wasm-test.sh                  # bootstraps .tools/ if missing, then runs browser tests

Pass extra cargo test args through wasm-test.sh, e.g. ./scripts/wasm-test.sh --test selection.

Commit & PR conventions

  • Branching: trunk-based on main; topic branches for anything non-trivial.
  • Commits: Conventional Commits — feat:, fix:, docs:, refactor:, test:, chore:.
  • PRs: every PR should tick at least one checkbox in ROADMAP.md or move an item between sections, and update the relevant phase checklist in the same PR as the behavior change.
  • Issues: label by phase (phase-0 … phase-7) and crate (crate:core, crate:dom, …).

Scope discipline

LOC and time budgets in DESIGN_NOTES.md §3 are honest and binding. New work that pushes past them goes into Deferred unless it unblocks v0.1. Pushing back on scope creep is encouraged, not discouraged.

Architectural invariants

  • Pure Rust at runtime — no JS bridge in published crates.
  • taino-edit-core must not depend on web-sys, leptos, or dioxus.
  • #![deny(unsafe_code)] everywhere except taino-edit-dom, where any unsafe at the FFI boundary must carry an inline // SAFETY: comment.

Code of conduct

This project follows the Rust Code of Conduct. By participating you are expected to uphold it.