Skip to content

docs(build): document the debug_assertions policy - #130

Open
loss-and-quick wants to merge 1 commit into
mainfrom
chore/build-debug-assertions-policy
Open

docs(build): document the debug_assertions policy#130
loss-and-quick wants to merge 1 commit into
mainfrom
chore/build-debug-assertions-policy

Conversation

@loss-and-quick

Copy link
Copy Markdown
Owner

Summary

Pin down the debug-vs-release policy so it stops being ambiguous. debug_assertions governs dev-only behavior and nothing else:

  • regenerating the frontend bindings (export_generated, src-tauri/src/lib.rs),
  • keeping the Windows console attached (windows_subsystem, src-tauri/src/main.rs).

Nightly and release are plain cargo tauri build (release profile, assertions off) and must not depend on debug_assertions for any shipped behavior; the product version is injected via tauri build --config, not a build profile. Records this in AGENTS.md and aligns the comments at both cfg(debug_assertions) sites. No behavior change.

Affected layer

  • crates/ · src-tauri/ — Rust (comments only)
  • Docs only — AGENTS.md

Verification

  • cargo fmt --all --check
  • cargo check -p kasumi-desktop

Comment/markdown-only; no logic, types, codegen, or strings changed.

Checklist

  • Title is a scoped Conventional Commit; single logical change
  • No build artifacts committed
  • No generated files or user-visible strings changed

Notes for reviewers

Documentation/intent only — establishes the contract so future work doesn't overload debug_assertions.

Pin down what debug_assertions governs (dev-only: frontend codegen +
Windows dev console) so nightly/release stay plain assertions-off builds
that never depend on it. Record it in AGENTS.md and align the comments at
both cfg(debug_assertions) sites.
@github-actions github-actions Bot added documentation Improvements or additions to documentation backend Rust core/backend/desktop (crates/, src-tauri/) labels Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backend Rust core/backend/desktop (crates/, src-tauri/) documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant