Project Operations

Operational guide for contributors and maintainers.

Daily Developer Flow

  1. Update branch and submodules.
  2. Run local checks (flutter analyze, selected tests, docs generation).
  3. Verify at least one target runtime (web, linux, windows, or android).
  4. Open pull request with clear scope and verification notes.

Quality Gates

Static checks

flutter analyze
dart format --set-exit-if-changed .

Tests

flutter test
flutter test integration_test/simple_test.dart

Documentation Workflow

Generate docs:

bash scripts/linux/generate-docs.sh

Preview docs:

dhttpd --path doc/api --host 127.0.0.1 --port 8080

CI/CD Notes

  • Linux native, Windows native, Web, and Android pipelines are available via GitHub Actions.
  • Keep generated artifacts deterministic to reduce CI diffs and flaky builds.
  • Prefer script-driven commands from scripts/ over ad-hoc commands for reproducibility.

Release Hygiene

  • Keep dependency upgrades and feature changes in separate pull requests.
  • Regenerate bridge code when Rust API signatures change.
  • Update docs in the same pull request for any user-facing behavior changes.

Contribution Checklist

  • [ ] Scope is focused and documented.
  • [ ] Build/test commands were run locally.
  • [ ] Relevant docs were updated.
  • [ ] No secrets, machine-specific paths, or temporary artifacts were committed.