Skip to content

Commit 1ae6c11

Browse files
Module authors have direct development and validation procedures (#565)
Module authors get direct, evergreen procedures for bootstrap, coordinated development, framework-test exceptions, validation, module tests, and plugin-skill authoring. Descriptions state supported facts; procedures use active instructions and explicit conditions. This change revises guidance only. It requires no module, workflow, configuration, or dependency migration. Executable examples and runtime/version constraints remain unchanged. <!-- ANNOUNCEMENT STOP --> ## Changed: Module guides state direct procedures and supported facts The six guides replace conversational, vague, and future-delivery wording with present-state descriptions and verifiable actions. The test guide names the v5.1.1 action contract that the workflow uses and states its unsupported optional-control limitation without a future implementation promise. Its Pester declaration keeps the exact minimum and maximum from the existing code block, without the misleading `6.1.x` prose label. The bootstrap version-policy conflict and OS-qualified shared-resource example conflict remain explicit follow-ups. This prose delivery does not choose a new version policy or change executable examples. <details> <summary>Technical details</summary> **Source comparison and delivery.** Base `64ffb1d87f86bd5d487891fdb140b78385a00531`; final pushed head `d33a7e1773f9bde2527ae94fea7a8ed2c22a4acf`. Six small commits are pushed. This draft opened immediately after the first coherent commit, `5f5062cca628831bc4f3de8864c84bb2759ed6f7`. It stays in draft by request. No merge, auto-merge, Agent merge, or additional child session is used. **Manual review and before/after evidence.** Every assigned file is read in full before edits and in the final review, including unchanged passages and examples. All six files change; no assigned guide is omitted or given an unverified no-change result. | Exact changed path | Before | After | | --- | --- | --- | | `docs/content/get-started/module-bootstrap.md` | "the piece(s) every other function will depend on"; "first real release" | "contains the components that all other module functions require"; "first release (`v1.0.0`)". | | `docs/content/guides/module-development-orchestration.md` | "a second place where the implementation is silently changed" | "The orchestrator does not change a child's implementation without a recorded scope decision." | | `docs/content/guides/skipping-framework-tests.md` | "will cause the framework to skip"; "will log a warning" | "The framework skips only the identified test for that file. It writes the supplied reason as a warning in the build output." | | `docs/content/guides/validating-before-review.md` | "current enough that generated documentation will stay accurate" | "public-function links resolve and usage examples match the implemented parameters and outputs". | | `docs/content/guides/writing-module-tests.md` | "will expose them after"; "current v5.1.0"; a `6.1.x` label for a broader declaration | The pinned v5.1.1 contract does not accept the optional controls; the reusable workflow does not expose them. The declaration is introduced as "this Pester requirement". | | `docs/content/guides/writing-plugin-skills.md` | "an operational entry point for an agent; shared process and policy belongs" | "A skill is an agent's entry point. Shared process and policy belong in the documentation". | **Meaning and protected content.** The immutable source comparison verifies 10 byte-identical fenced examples, 54 headings unchanged except sentence case, and all 85 distinct per-file inline technical tokens retained. Manual comparison preserves public inputs/defaults, paths, framework-test IDs, warning semantics, discovery precedence, bootstrap rules, caller-provided `TestData`, and normative requirement strength. No normative requirement is presented as proof of CI enforcement. No link repair requires another owner's file. **Writing sources.** The fixed writing baseline is `MSXOrg/docs@1b0d4893c8fefabe604d04393068a8ff6f848082`: [Natural Language](https://github.com/MSXOrg/docs/blob/1b0d4893c8fefabe604d04393068a8ff6f848082/src/docs/Coding-Standards/Natural-Language.md), [Writing Guide](https://github.com/MSXOrg/docs/blob/1b0d4893c8fefabe604d04393068a8ff6f848082/src/docs/Coding-Standards/Writing-Guide.md), [Markdown](https://github.com/MSXOrg/docs/blob/1b0d4893c8fefabe604d04393068a8ff6f848082/src/docs/Coding-Standards/Markdown.md), [Documentation](https://github.com/MSXOrg/docs/blob/1b0d4893c8fefabe604d04393068a8ff6f848082/src/docs/Coding-Standards/Documentation.md), [Documentation Model](https://github.com/MSXOrg/docs/blob/1b0d4893c8fefabe604d04393068a8ff6f848082/src/docs/Ways-of-Working/Documentation-Model.md), and the [guide template](https://github.com/MSXOrg/docs/blob/1b0d4893c8fefabe604d04393068a8ff6f848082/src/docs/Ways-of-Working/Spec-Driven-Development-Templates.md#guide). The review also uses the [STEMG description](https://www.asd-ste100.org/about_STE.html), [STEMG FAQ](https://www.asd-ste100.org/STE_faq.html), and [ASD-STE100 Issue 9](https://doi.org/10.5281/zenodo.23666006), including relevant writing rules and dictionary entries. The reference PDF and extraction stay local; the verified PDF MD5 is `9c720341c350ed77943b2c73d01c716f`. No required writing source is unavailable. Automated checks do not prove full STE conformance. | Changed surface | Standards checked | Framework/source evidence checked | Result | | --- | --- | --- | --- | | `module-bootstrap.md` | Fixed writing baseline and guide template | Existing bootstrap branch/release contract; versioning reference | Exception - #573 preserves the policy conflict. | | `module-development-orchestration.md` | Fixed writing baseline and guide template | Existing child scope, handoff, integration, and release-readiness contract | Fixed in this PR. | | `skipping-framework-tests.md` | Fixed writing baseline and guide template | Source-code `FunctionCount` skip handling and warning output | Fixed in this PR. | | `validating-before-review.md` | Fixed writing baseline and guide template | Module structure, native-help, and test reference requirements | Fixed in this PR. | | `writing-module-tests.md` | Fixed writing baseline and guide template | Discovery/settings source, test/setup/teardown workflows, and pinned action interface | Exception - #571 preserves the executable sample conflict. | | `writing-plugin-skills.md` | Fixed writing baseline and guide template | Existing plugin README, directory structure, plugin metadata, and marketplace registration | Fixed in this PR. | **Read-only inspections and justified no-change results.** Supporting files/sections: `README.md`; `AGENTS.md`; `.gitignore`; `.github/actions/Get-PSModuleSettings/src/main.ps1`; `.github/actions/Test-PSModule/src/tests/SourceCode/PSModule/PSModule.Tests.ps1`; `.github/workflows/workflow.yml`; `.github/workflows/Test-ModuleLocal.yml`; `.github/workflows/BeforeAll-ModuleLocal.yml`; `.github/workflows/AfterAll-ModuleLocal.yml`; `.github/workflows/Docs.yml`; `.github/workflows/Linter.yml`; `.github/workflows/Release.yml`; `.github/linters/.markdown-lint.yml`; `.github/linters/.textlintrc`; `.github/plugin/README.md`; `.github/plugin/psmodule/plugin.json`; `.github/plugin/marketplace.json`; `docs/zensical.toml`; and the relevant sections of `docs/content/reference/{versioning,powershell-module-standard,test-specification}.md`. They need no edit because this delivery changes guide prose, not their contracts, implementation, native help, tests, metadata, or configuration. The remote [Invoke-Pester action contract](https://github.com/PSModule/Invoke-Pester/blob/c5494aba3c07d7bfd81bdbbc9f301e8fa4a729fb/action.yml) is read at exact SHA `c5494aba3c07d7bfd81bdbbc9f301e8fa4a729fb`. The v5.1.1 tag independently resolves to that commit. Its interface lacks `Run.Shuffle`, `Run.ShuffleSeed`, `Run.Parallel`, `Run.ParallelThrottleLimit`, and `Debug.ShowStartMarkers`. Neither workflow action references nor Pester/runtime constraints change. **Exclusions.** Every other repository path is excluded: other getting-started and guide pages, reference pages, indexes, specifications, dictionary pages, assets/site design, plugin skills/metadata, code, tests/assertions, and configuration. Reserved release/workflow/structure/configuration surfaces remain with #524, #525, #531, #535, #537, #541, #548, and #549. #551 changes no documentation or native help. Live open-PR path ownership is checked before every commit; no other PR owns an assigned path. **Checks on the final head.** | Command or review | Result | | --- | --- | | `git diff --check 64ffb1d` | Pass. | | `npx --no-install markdownlint-cli2 --config .github\linters\.markdown-lint.yml` with the six exact assigned paths | Pass: 6 files, 0 issues. | | `zensical build --clean` from `docs` | Pass: "No issues found", exit 0. | | Existing `rules.terminology` through `TextlintKernel.lintText` | Pass: 6 final guides, 0 issues; an intentional `Powershell` positive control reports the `PowerShell` correction. | | Standard-library scoped Markdown/generated-HTML link review | Pass: 33 relative links, 9 rendered fragments, 0 issues. | | Exact committed `git show` source comparisons | Pass: 10 byte-identical fences, 54 stable headings, 85 retained per-file inline technical tokens, exact six-file scope. | | Six original wording cases | Each fails on the original baseline and passes at the final head. The additional misleading Pester-range label is absent. | | `ConvertFrom-Json` on plugin and marketplace metadata | Pass; both files are unchanged. | The direct terminology CLI is absent; the cache-only attempt confirms missing packages before a session-local restore. Its Windows CLI loader does not load the configured rule. The successful kernel invocation loads the existing Markdown parser and exact `rules.terminology` options from `.github/linters/.textlintrc`, with an active positive control. No repository dependency, linter, or configuration is added. No standalone link-check script exists in this snapshot; the scoped check uses Python's standard library and actual generated HTML. It does not claim exhaustive external-site validation. Generated site output and the temporary checker restore are removed after verification; the worktree is clean and local/remote commit counts are `0 0`. **Hosted status on the final head.** `gh pr checks 565 --repo PSModule/Process-PSModule --json name,state,link` reports 22 successful checks, one skipped Publish check, and no pending or failed checks. Copilot approves `d33a7e1773f9bde2527ae94fea7a8ed2c22a4acf` with "No open issues" and no inline comments. Final-head Build, Lint, Lint code base, CodeQL, and Analyze (actions) pass. No new local failure or scope blocker remains. The PR stays in draft for the requested acceptance review; these results do not authorize readiness or merge. **Plan and convergence.** #559 contains the current Task plan, pre-edit evidence, final acceptance evidence, and check results. Its author-side implementation steps are complete; the issue stays open until the normal review/merge path completes. The scoped sweep examines campaign issue titles and declared paths, plus bootstrap/major, version-policy, and `RUNNER_OS` searches. Only #559 is fully covered. #571 and #573 remain non-closing follow-ups; other campaign issues name excluded surfaces. The docs-only path set does not invoke the release workflow, so no release-decision block or `release:*` label applies. </details> <details> <summary>Related references</summary> - Resolves #559 - References #571 - References #573 </details>
1 parent 64ffb1d commit 1ae6c11

6 files changed

Lines changed: 218 additions & 205 deletions

File tree

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,35 @@
11
---
22
title: Module bootstrap
3-
description: How to get a brand-new module to its first release using a single integration branch for the load-bearing core.
3+
description: Release a module's load-bearing core through one integration branch.
44
---
55

66
# Module bootstrap
77

8-
A brand-new module usually has a small **load-bearing core**: the piece(s) every other function will depend on, without which nothing else in the module can work at all. A single feature PR cannot carry that much scope and still be small and focused, so bootstrap uses one integration branch instead.
8+
A module's **load-bearing core** contains the components that all other module functions require. The module cannot work without these components.
9+
10+
If the core exceeds one focused feature pull request, use one integration branch for bootstrap.
911

1012
## Identify the load-bearing core first
1113

12-
What counts as "load-bearing" follows the module's archetype from [Module types](../reference/module-types.md):
14+
Identify the core from the module's archetype in [Module types](../reference/module-types.md):
1315

14-
- **Data modules** — the conversion pivot: `ConvertFrom-<Format>` / `ConvertTo-<Format>` (and whatever parser/serializer they wrap). Every other function (`Import-`, `Export-`, `Format-`, `Merge-`, ...) is built on top of this pivot and is meaningless without it.
15-
- **Integration (API) modules** — a [`Context`](https://github.com/PSModule/Context)-backed credential/config store, the client setup that uses it, and at least one API function that consumes the context end-to-end. Every other API function needs the same context and client to do anything.
16+
- **Data modules** - The core is the conversion pivot: `ConvertFrom-<Format>` / `ConvertTo-<Format>` and any parser or serializer they use. Other functions (`Import-`, `Export-`, `Format-`, `Merge-`, ...) depend on this pivot.
17+
- **Integration (API) modules** - The core contains a [`Context`](https://github.com/PSModule/Context)-backed credential and configuration store, its client setup, and at least one API function. That API function uses the context end-to-end. Other API functions depend on the same context and client.
1618

17-
Scope the integration branch to exactly that core, not to everything planned for v1. Keeping it to the minimum that "everyone needs" gets a usable release out faster, and lets independent follow-up functions be developed in parallel — by different people or agents — as soon as the core is stable enough to build against, even before it merges.
19+
Limit the integration branch to this core, not all features planned for v1. Contributors or agents can develop independent follow-up functions in parallel before the core merges. Start this work only when the core supports those functions.
1820

1921
## Pattern
2022

21-
1. Cut one long-lived branch from the default branch for the initial release, named for the outcome, e.g. `build-thing-module`.
22-
2. Open one pull request per function (or small group of related functions) targeting that branch instead of `main`. These PRs can land in parallel — there is no strict order between them, unlike a [stacked pull request](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/#stacked-pull-requests).
23-
3. Once the load-bearing core is coherent and complete, open the pull request that merges the integration branch into `main`. Its resulting important push becomes the module's first real release (`v1.0.0`).
24-
4. Smaller follow-up features (one more function, a formatter, an alias) can keep targeting the integration branch before it lands, the same way they targeted it during bootstrap.
23+
1. Create one long-lived branch from the default branch for the initial release. Name it for the outcome, for example, `build-thing-module`.
24+
2. Open one pull request per function or small group of related functions. Target the integration branch instead of `main`. Independent pull requests can merge in any order, unlike a [stacked pull request](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/#stacked-pull-requests).
25+
3. When the core is complete and consistent, open the pull request from the integration branch to `main`. The resulting important push produces the module's first release (`v1.0.0`).
26+
4. To include smaller follow-up features before integration, target the same integration branch. Examples include another function, a formatter, or an alias.
2527

2628
## After the core lands
2729

28-
Once the core has merged as `v1.0.0`, ordinary [SemVer](../reference/versioning.md) applies: a new function built on the stable core is a **minor** bump, a fix is a **patch** bump, and only a change to the core's own contract (signature, exported class shape, behavior) is a **major** bump. No special versioning exception is needed once the core is in place — the bootstrap phase exists only to get that core to a first release quickly.
30+
After the core merges as `v1.0.0`, ordinary [SemVer](../reference/versioning.md) applies. A new function on the stable core is a **minor** bump. A fix is a **patch** bump. Only a change to the core's own contract (signature, exported class shape, behavior) is a **major** bump.
31+
32+
Bootstrap has no versioning exception after the core's first release. The bootstrap phase provides the core's initial usable release.
2933

3034
```mermaid
3135
gitGraph
@@ -46,20 +50,20 @@ gitGraph
4650
merge build-thing-module id: "v1.0.0"
4751
```
4852

49-
`function-a` and `function-b` are independent — both cut from `build-thing-module` and merged back in any order, unlike a stacked pull request where each layer depends on the one before it.
53+
`function-a` and `function-b` are independent. Both start from `build-thing-module` and can merge into it in any order. In a stacked pull request, each layer depends on the preceding layer.
5054

5155
## Example
5256

53-
A module bootstrapped this way:
57+
The example uses one bootstrap integration branch:
5458

5559
| PR | Targets | Contents |
5660
| --- | --- | --- |
57-
| #1 | `main` | `build-thing-module` branch, the load-bearing core (e.g. conversion pivot, or context + client + first API function) |
58-
| #2 | `build-thing-module` | a follow-up function built on the core, added before the integration branch merged |
61+
| #1 | `main` | `build-thing-module` branch with the load-bearing core, such as a conversion pivot or context, client, and first API function |
62+
| #2 | `build-thing-module` | A follow-up function on the core, added before the integration branch merges |
5963

6064
## When to use this
6165

62-
- The module has no usable release yet, and the load-bearing core hasn't landed.
63-
- Use this only for the initial bootstrap. Once `main` has a first release, ongoing feature work targets `main` directly with ordinary topic branches, or uses a [stacked pull request](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/#stacked-pull-requests) when changes genuinely depend on each other.
66+
- Use bootstrap only when the module has no usable release and the load-bearing core has not merged.
67+
- After `main` has a first release, target `main` with ordinary topic branches. Use a [stacked pull request](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/#stacked-pull-requests) only for dependent changes.
6468

6569
For the general branching and merge model, see [MSX Branching and Merging](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/).
Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
---
22
title: Module development orchestration
3-
description: Coordinate substantial module work across an orchestrator session and narrowly scoped child sessions, then integrate it safely for release.
3+
description: Coordinate scoped module changes through an orchestrator, child sessions, and verified integration.
44
---
55

66
# Module development orchestration
77

8-
Substantial module work is easier to review and integrate when it is split into
9-
small, independently verifiable changes. Use one parent (orchestrator) session
10-
to own the plan and integration, and use narrowly scoped child sessions for the
11-
work that can proceed independently.
8+
Coordinate module work as small, independently verifiable changes. Use one
9+
parent (orchestrator) session for the plan and integration. Assign independent
10+
work to narrowly scoped child sessions.
1211

13-
This complements [Module bootstrap](../get-started/module-bootstrap.md). During
14-
bootstrap, the shared branch is an **integration branch** for the load-bearing
15-
core. For an existing module, follow the repository's
12+
During [Module bootstrap](../get-started/module-bootstrap.md), the shared
13+
**integration branch** holds the load-bearing core. For an existing module,
14+
follow the repository's
1615
[trunk-based development](../specification/principles-and-practices.md#trunk-based-development)
1716
default: child pull requests use short-lived branches and target `main`.
1817
Use a stacked pull request only when a dependency requires it.
@@ -27,36 +26,34 @@ The orchestrator:
2726
- creates the bootstrap integration branch and its draft pull request to
2827
`main` when the module needs one
2928
- gives each child one reviewable unit of work and the branch it must target
30-
- keeps shared design decisions, naming, and cross-cutting changes coherent
29+
- keeps shared design decisions, naming, and cross-cutting changes consistent
3130
- reviews each child pull request, runs the relevant validation, and integrates
3231
it into the shared branch
3332
- owns release readiness for the coordinated change set
3433

35-
The orchestrator coordinates the work; it does not become a second place where
36-
the implementation is silently changed. Changes outside a child's scope should
37-
become a new child task or an explicitly recorded decision.
34+
The orchestrator does not change a child's implementation without a recorded
35+
scope decision. For changes outside a child's scope, the orchestrator should
36+
create a separate child task or record an explicit decision.
3837

3938
### Child session
4039

41-
A child session owns one cohesive change, such as one public function and its
42-
tests, one documentation page, or one focused fix. A child should be able to
43-
describe its change without referring to unrelated planned work.
40+
A child session owns one cohesive change. Examples include one public function
41+
with tests, one documentation page, or one focused fix. A child should be able
42+
to describe its change without references to unrelated planned work.
4443

45-
Each child:
44+
For each assigned change:
4645

47-
1. starts from `main`, or from the bootstrap integration branch when one is
48-
required
49-
2. opens a **draft pull request** targeting `main`, or the bootstrap integration
50-
branch when one is required
51-
3. implements and validates only its assigned scope
52-
4. updates the documentation and tests required by that scope
53-
5. reports the result to the orchestrator before asking for integration
46+
1. Start from `main` or the required bootstrap integration branch.
47+
2. Open a **draft pull request** that targets the same branch.
48+
3. Implement only the assigned scope. Validate the assigned change.
49+
4. Update the documentation and tests required by that scope.
50+
5. Before you request integration, report the result to the orchestrator.
5451

55-
Use the repository's normal [branching and merging
52+
Follow the repository's [branching and merging
5653
practice](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/) and the
57-
shared [workflow](https://msx.no/docs/Ways-of-Working/Workflow/) for the
58-
ordinary branch, draft PR, implementation, test, and review loop. This page
59-
only describes how to coordinate several such changes.
54+
shared [workflow](https://msx.no/docs/Ways-of-Working/Workflow/) for branches,
55+
draft PRs, implementation, tests, and review. This page describes how to
56+
coordinate those changes.
6057

6158
## Coordination protocol
6259

@@ -73,9 +70,9 @@ The orchestrator's handoff should include:
7370
- the validation expected before the child reports completion
7471
- the orchestrator session's identifier or communication channel
7572

76-
If the child discovers a missing prerequisite or a conflicting design choice,
77-
it should stop at that boundary and report it rather than expanding its scope
78-
silently.
73+
If a prerequisite is missing or a design decision conflicts, the child should
74+
stop at that boundary. The child should report the problem instead of
75+
expanding its scope without a record.
7976

8077
### Require a useful completion report
8178

@@ -88,50 +85,53 @@ The child reports:
8885
- decisions or risks the orchestrator must review
8986
- follow-up issues for work that does not belong in the child pull request
9087

91-
The orchestrator treats this as input to review, not as a substitute for
92-
review. Read the diff, verify the acceptance criteria, and run the smallest
93-
relevant checks before merging. Use
88+
The completion report does not replace review. Before you merge, read the
89+
diff. Make sure that it satisfies the acceptance criteria. Run the smallest
90+
relevant checks. Use
9491
[Validating before review](validating-before-review.md) for the PSModule
95-
specific validation pass.
92+
validation pass.
9693

9794
### Integrate deliberately
9895

99-
Merge children only after their checks and review are complete. Merge
100-
independent children into `main` in any order. For dependent work, either wait
101-
for the prerequisite to merge or make the dependency explicit in a stacked
102-
branch arrangement; do not make a child appear independent by copying
103-
unreviewed changes. During bootstrap, merge children into the integration
104-
branch, then merge that branch to `main` when the load-bearing core is ready.
96+
After checks and review are complete, merge independent child pull requests
97+
into `main` in any order. For dependent work, wait for the prerequisite to
98+
merge or use an explicit stacked branch arrangement. Do not copy unreviewed
99+
changes to make a child appear independent.
105100

106-
Keep `main` or the bootstrap integration branch buildable. Resolve conflicts in
107-
the orchestrator's context, rerun affected checks after integration, and record
108-
any cross-cutting decision in the relevant pull request or issue.
101+
During bootstrap, merge child pull requests into the integration branch.
102+
When the load-bearing core is ready, merge that branch to `main`.
103+
104+
Keep `main` or the bootstrap integration branch buildable. Resolve conflicts
105+
in the orchestrator's context. After integration, rerun the affected checks.
106+
Record cross-cutting decisions in the relevant pull request or issue.
109107

110108
## Release readiness
111109

112-
Release readiness is a property of the integrated change, not a reason to keep
113-
a long-lived release branch. Before marking a bootstrap integration pull
114-
request ready, or reporting a coordinated trunk-based change complete, confirm:
110+
Release readiness applies to the integrated change. It does not justify a
111+
long-lived release branch. Before you mark a bootstrap integration pull
112+
request ready, examine the integrated change against these conditions.
113+
Apply the same conditions before you report a coordinated trunk-based change
114+
complete:
115115

116116
- every child pull request is merged, closed with a documented reason, or
117117
explicitly deferred with a follow-up issue
118118
- the integrated branch passes the applicable build, test, lint, and
119119
documentation checks
120-
- the final tree still follows
120+
- the final tree follows
121121
[Structuring your module](structuring-your-module.md), the module
122122
[repository standard](../reference/repository-standard.md), and the
123123
[test specification](../reference/test-specification.md)
124124
- user-facing documentation, examples, and generated-help inputs describe the
125125
integrated behavior
126-
- the parent or coordinating pull request records the outcome, links the child
127-
pull requests when one exists, and identifies related issues without claiming
126+
- if a parent or coordinating pull request exists, it records the outcome and
127+
links the child pull requests. It identifies related issues without claiming
128128
unrelated work
129129
- the version and prerelease intent match
130130
[Versioning and releases](versioning-and-releases.md)
131131

132-
If the change is not ready, keep the relevant pull request in draft and create
133-
another focused child task or follow-up issue. Once it is ready, follow [Your
134-
first release](../get-started/your-first-release.md) and the canonical MSX
132+
If the change is not ready, keep the relevant pull request in draft.
133+
Create a focused child task or follow-up issue for the remaining work.
134+
When the change is ready, follow [Your first release](../get-started/your-first-release.md) and the canonical MSX
135135
[definition of ready for review](https://msx.no/docs/Ways-of-Working/Definition-of-Ready-and-Done/#definition-of-ready-for-review).
136136

137137
## Relationship to other work
@@ -140,6 +140,6 @@ first release](../get-started/your-first-release.md) and the canonical MSX
140140
needs a load-bearing core before its first release.
141141
- For an existing module, use short-lived topic branches targeting `main`, as
142142
described in [Principles and practices](../specification/principles-and-practices.md).
143-
- Use a stacked pull request only when the changes genuinely depend on one
144-
another; see [MSX branching and
143+
- Use a stacked pull request only when one change depends on another.
144+
See [MSX branching and
145145
merging](https://msx.no/docs/Ways-of-Working/Branching-and-Merging/).

0 commit comments

Comments
 (0)