yisroelbaum/Goal-Calibration
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add no default parameters rule

Browse source 
Forcing every call site to be explicit eliminates a class of bugs where an unintended default silently slips through. Codifies the convention already established by prior commits (cd40483, b41652a, 8eb0f23).
This commit is contained in:
Yisroel Baum 2026-05-01 10:04:32 +03:00
parent 4294521dfc
commit 8b5767e6f4
Signed by: yisroelbaum
GPG key ID: 0FA60884F75520A9
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
ai/shared.md
View file

@ -24,6 +24,11 @@ guides (`backend-context.md`, `frontend-context.md`) extend these.
possible - do not split lines unnecessarily possible - do not split lines unnecessarily
- Variable names: use explicit, descriptive names - never single-letter or - Variable names: use explicit, descriptive names - never single-letter or
abbreviated variables (e.g. `$text` not `$t`, `$node` not `$n`) abbreviated variables (e.g. `$text` not `$t`, `$node` not `$n`)
- Method/function/constructor parameters: do not use default values - every
call site must pass every argument explicitly. This eliminates a class of
bugs where an unintended default silently slips through (e.g. an
`isAdmin=false` or an empty `passwordHash`). Apply the same rule in tests
and fakes - if a helper accepts a value, every caller must supply it.
- First, explore the codebase to understand existing patterns - look at similar - First, explore the codebase to understand existing patterns - look at similar
files for reference before writing anything files for reference before writing anything
- Never use em dashes (—) in code, comments, or docblocks - use hyphens (-) - Never use em dashes (—) in code, comments, or docblocks - use hyphens (-)