Commit 0b4b9e8
authored
π [Docs]: Module bootstrap branching pattern documented (#89)
Modules that need several interdependent functions before a first
release is usable now have a documented pattern to follow, instead of
improvising it per repo.
## New: Module Bootstrap page
`src/docs/Modules/Process-PSModule/module-bootstrap.md` documents the
pattern: identify the module's **load-bearing core** first (the
conversion pivot for data modules, or the Context-backed credential
store + client + first API function for integration modules, per the
existing [Module types](../Module-Types.md) archetypes), scope one
long-lived integration branch to exactly that core, and open small
focused PRs targeting that branch in parallel until it's coherent.
Merging the integration branch into `main` becomes the module's
`v1.0.0`. After that, ordinary SemVer applies β new functions on the
stable core are minor/patch bumps unless they break the core's own
contract. Follow-up feature PRs can keep targeting the integration
branch before it merges.
The page is linked from the `Process-PSModule` nav/index and
cross-referenced from `template-quickstart.md` for modules that need
this before the ordinary single-command quickstart applies.
## Technical Details
- Added `src/docs/Modules/Process-PSModule/module-bootstrap.md`,
cross-linking `Module-Types.md` and `Versioning.md`.
- Registered it in `src/zensical.toml` nav and
`Process-PSModule/index.md`.
- Added a one-line cross-reference from `template-quickstart.md`.
- No MSXOrg/docs changes: the existing "Stacked pull requests" / "Merge
models" sections in `Branching-and-Merging.md` already cover the general
framework; this page is a PSModule-specific application of it and links
out for contrast rather than duplicating that content.
Docs-only change, no issue required.1 parent 6bf69bd commit 0b4b9e8
4 files changed
Lines changed: 64 additions & 0 deletions
File tree
- src
- docs/Modules/Process-PSModule
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| 13 | + | |
13 | 14 | | |
14 | 15 | | |
Lines changed: 60 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
Lines changed: 2 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| 15 | + | |
| 16 | + | |
15 | 17 | | |
16 | 18 | | |
17 | 19 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| 36 | + | |
36 | 37 | | |
37 | 38 | | |
38 | 39 | | |
| |||
0 commit comments