Skip to content

docs: avoid needless compatibility layers #40

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
jan-kubica merged 1 commit into from
Aug 9, 2026
Merged

docs: avoid needless compatibility layers #40

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
5 changes: 5 additions & 0 deletions modules/engineering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
unnecessary words, a paragraph no unnecessary sentences, for the same reason that a
drawing should have no unnecessary lines and a machine no unnecessary parts. Applies
to comments, commits, PRs, and docs.
- Do not add backward-compatibility machinery by default. First identify the concrete
older clients, persisted data, integrations, or deployment states that must remain
supported. When none exist, prefer a clean migration or cutover; aliases, dual
reads/writes, and staged paths add permanent complexity. When compatibility is
required, document its boundary and removal condition.
- Prefer explicit over implicit; when a backend endpoint accepts a discriminator
(e.g., `?type=document|file`), thread it through the full stack (URL params,
component props) instead of hardcoding a default on the frontend
Expand Down
Loading