Principles 11 and 12, and the reviewers ask them #629

Merged
mesh-tools merged 2 commits from principles/configurable-and-own-files into main 2026-11-16 12:53:40 +00:00
3 changed files with 11 additions and 0 deletions
+4
View File
@@ -26,6 +26,10 @@ questions are.
- an interaction the design does not place that is not a mesh path: one module naming another, reading another's
internals or being special-cased in another part; a module's name in shared code; state only in memory; a poll or
a timer where an event exists;
- a value written into the code that can differ between machines, modules or over time (a port, a path, a bound, a
cap, a name, a time) and is not a setting with a default (principle 11); name the setting it should be, eagerly;
- a module that writes another module's file or state, or anything in another module's place, instead of giving it
through a provision or a contribution that module declares (principle 12);
- an effect or a reader of the build map's `What exists today` whose fate the diff does not carry out (run its
searches again on the reviewed tree), or one the search finds and the answer omits;
- a test that does not fail without its change (check it by taking the change out in a copy), an acceptance
+3
View File
@@ -25,6 +25,9 @@ write.
What you judge:
- Seams: where each piece of state lives on the bus (key-value bucket, stream, object store) and which module owns it; which seat, verb or event joins two parts; any link that is not NATS-native (a poll, a timer, HTTP between modules, a shared file, state only in memory); whether a form the manifest lacks is named with its cost (a mesh-sdk change rebuilds every module).
- Settings and ownership: every value that can differ between machines, modules or over time is a setting with a
default, never hard-coded (principle 11), and the design names it; no module writes another module's file or state:
what one module needs from another goes through a provision or a contribution that module declares (principle 12).
- Tools: for every new piece of state a tool that reads it, and for every new behaviour a tool that steers it (do by hand, ask again, drop, repair, re-check), as the instruction tools-are-how-a-module-is-spoken-to says.
Judge only whether the settled direction or design is complete and sound in your two architectural domains,
+4
View File
@@ -30,6 +30,10 @@ add, sharpen or drop a principle in a pull request to this file.
module's internals.
10. **The module is the unit.** Everything is done per module, never per repository. A repository is only where a
module's files are kept; a merge moves only the modules it changes.
11. **Configurable, never hard-coded.** A value that can differ between machines, modules or over time (a port, a
path, a bound, a cap, a name, a time) is a setting with a default, never written into the code.
12. **A module writes only its own.** A module writes its own files and state alone; what another module needs from it
goes through a provision or a contribution that module declares, never a file written in its place.
How it is checked: the one code review of a milestone checks the code against these principles and the design's
shape; an answer to a develop question names the principle that settles it.