Merge chore/self-explanatory-code into develop
This commit is contained in:
commit
dc6507dc86
1 file changed
+4
-2
+4
-2
@@ -8,7 +8,8 @@ Apply unless repo-specific instructions override.
|
|||||||
- Simple, readable, maintainable > clever or compact.
|
- Simple, readable, maintainable > clever or compact.
|
||||||
- One responsibility per function/method.
|
- One responsibility per function/method.
|
||||||
- Preserve existing behavior unless asked.
|
- Preserve existing behavior unless asked.
|
||||||
- Scope changes to task — no unrelated edits.
|
- Scope changes to task — no unrelated edits. Literal ask: button color →
|
||||||
|
change the color, no theme or token system. Idea beyond scope → ask first.
|
||||||
- Before writing code, stop at the first rung that applies: not needed
|
- Before writing code, stop at the first rung that applies: not needed
|
||||||
(YAGNI) → reuse what the codebase has → stdlib → platform/runtime
|
(YAGNI) → reuse what the codebase has → stdlib → platform/runtime
|
||||||
feature → dependency already installed → one line → the minimum that
|
feature → dependency already installed → one line → the minimum that
|
||||||
@@ -23,7 +24,8 @@ Apply unless repo-specific instructions override.
|
|||||||
- No global state. Explicit data flow.
|
- No global state. Explicit data flow.
|
||||||
|
|
||||||
## Comments & readability
|
## Comments & readability
|
||||||
- Document intent, not mechanics. Use project doc style (docstring, JSDoc…).
|
- Self-explanatory code: names and structure carry the meaning. Comment only
|
||||||
|
what the code can't say (why, intent). Project doc style (docstring…).
|
||||||
- Explicit, consistent names. Straight control flow, no hidden side effects.
|
- Explicit, consistent names. Straight control flow, no hidden side effects.
|
||||||
- Written deliverables (docs, reports, .md): length matched to the task, no
|
- Written deliverables (docs, reports, .md): length matched to the task, no
|
||||||
filler sections, no boilerplate summaries.
|
filler sections, no boilerplate summaries.
|
||||||
|
|||||||
Reference in new issue
Block a user