Compare commits

..
1 Commits
Author SHA1 Message Date
jschoubben 9f08a430aa Principles: logic belongs to one module, named by its seat; the least code in shared packages
The operator, 2026-11-22: "it's better to let module A use module B's tool than both using a shared sdk function"; "logic should belong to a specific module, defined by its contract (seat)"; and at 21:02: "since seats can have multiple (applicable) occupant modules, the seat contract is generic, but the occupant module can have vendor-specific tools on top of the seat tools".
2026-11-22 21:00:21 +01:00
+14 -1
View File
@@ -1,6 +1,6 @@
---
status: canonical
updated: 2026-11-16
updated: 2026-11-22
---
# The principles
@@ -34,6 +34,19 @@ add, sharpen or drop a principle in a pull request to this file.
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.
13. **Logic belongs to one module, named by its seat.** What a module does lives in that module, named by the seat it
holds, whose verbs are its contract. Another module that needs it calls the seat's verbs where the need is
interchangeable between the seat's holders, and the holding module's own tool only where that module alone fills
the need (a holder may serve tools of its own beside the seat's verbs); never a shared function both import.
mesh-sdk, the domain SDKs and the contracts modules hold the least code possible: every change to a package is
published before any module can use it, and every importer is then rebuilt. A function moves into a shared
package only when it is a seat's contract itself: its records, keys and events, and the client package of its
verbs.
*The operator, 2026-11-22: "it's better to let module A use module B's tool than both using a shared sdk
function"; "logic should belong to a specific module, defined by its contract (seat)"; and at 21:02: "since seats
can have multiple (applicable) occupant modules, the seat contract is generic, but the occupant module can have
vendor-specific tools on top of the seat tools".*
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.