Skip to content

Clean up design principles #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DracoWhitefire merged 1 commit into from
Oct 21, 2026
Merged

Clean up design principles #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions src/principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# Principles

- **Hardware behind traits.** SCDC transport and PHY control are injected, so all protocol
logic is testable without hardware.
- **Policy at the right layer.** Parsing layers make no judgements. The negotiation layer is
explicitly opinionated but configurable. Hardware layers implement specification, not policy.
- **Modular: pick, combine, replace.** Every layer can be used on its own, combined with
the others, or replaced by an implementation of the trait the layer above defines
- **Extensible without forking.** Every library in the stack is designed to be customized
and configured without modifying its source.
- **Diagnostics are first-class.** Structured reasoning traces and typed warnings instead of
logs. Rejected candidates are explained; nothing fails silently.
- **Spec-complete, judgment-free lower layers.** Parsing and protocol crates implement the
spec in full; policy lives in the negotiation layer, and you can override it.
- **`no_std` where it matters**, async companions where they help.
- **Hardware behind traits.** SCDC transport and PHY control are injected, so all protocol
logic is testable without hardware.
- **No unsafe code.** `#![forbid(unsafe_code)]` across the stack.
- **Stable output types.** Consumer-facing structs are `#[non_exhaustive]`, so new fields do
not break you.
Expand Down
Loading