Repository navigation
Contribution guidance states review and session duties directly - #271
Open
Marius Storhaug (MariusStorhaug) wants to merge 7 commits into
Open
Marius Storhaug (MariusStorhaug) wants to merge 7 commits into
Marius Storhaug (MariusStorhaug) wants to merge 7 commits into
Conversation
13 tasks done
There was a problem hiding this comment.
🟢 Approved
There are no active review issues for this documentation-only clarification of contribution responsibilities and workflow guidance.
No open issues 🎉
What changed in this PR
This documentation-only PR clarifies the contribution workflow by stating author and reviewer responsibilities directly. It supports the broader writing-alignment task without changing commands, review gates, or repository enforcement.
Changes:
- Replaces metaphorical explanations with explicit author review and feedback-triage duties.
- Clarifies readiness requirements and the conditions auto-merge waits for.
- Preserves headings, links, examples, and the Copilot review-loop contract.
| File | Description |
|---|---|
src/docs/Ways-of-Working/Contribution-Workflow.md |
Clarifies draft review, author responsibilities, readiness, and auto-merge guidance. |
Review effort: Balanced
Marius Storhaug (MariusStorhaug)
dismissed
Copilot’s stale review
via
November 4, 2026 12:34
e310d95
Marius Storhaug (MariusStorhaug)
dismissed
Copilot’s stale review
via
November 4, 2026 12:40
4de8a3b
Marius Storhaug (MariusStorhaug)
dismissed
Copilot’s stale review
via
November 4, 2026 13:05
5aa044a
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
November 4, 2026 14:43
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contribution guidance uses direct en-US explanations for branches, commits, worktrees, review duties, and session procedures. Commit guidance points change classification to canonical PR Format instead of asserting an unsupported metadata field.
Commands, recognized phrases, and review/release gates are unchanged. Contributors and reviewers need no workflow change. This clarification changes guidance only, not automation or enforcement. The campaign keeps this pull request in draft.
Changed: Contribution records state duties and session effects directly
The contribution pages replace metaphorical explanations with explicit actors, actions, conditions, and results. Authors still complete automated review before requesting human review. Reviewers retain blocking-concern and independent-approval duties. Session procedures retain their existing recording, continuation, read-only status, and confirmation requirements.
Commit Conventions states that classification belongs in the PR and links its canonical format. It adds no metadata field or unconditional label requirement. The no-conventional-prefix rule and every actual conditional release-label rule remain unchanged. No adoption action is required beyond reading the clarified explanations. PR Format remains unchanged, including its complete release-bound coverage and consumer-record requirements.
Technical details
Immutable scope and complete reading
The fixed criteria and scoped PR base are
1b0d4893c8fefabe604d04393068a8ff6f848082. The final candidate is5aa044a68db7f5bcf7927d1d1b48b2bbb1e701fd. The remote PR head and all observed final-head CI checks name that exact candidate. Seven small commits change six prose-only files, with 272 additions and 223 deletions. The working tree is clean.The source-resolved follow-up compares prior verified head
4de8a3b1a933b76d50197af8303cb12f83bb1d5cwith the final candidate. It changes exactly one sentence inCommit-Conventions.md, with one insertion and one deletion. The other six assigned pages and every other sentence in Commit Conventions are exact to that prior head. The unsupported field reference is corrected, not deferred as policy.Every assigned page was read in full, including every example and all 745 lines of PR Format.
src\docs\Ways-of-Working\Branching-and-Merging.mdsrc\docs\Ways-of-Working\Commit-Conventions.mdgit logreference are retained.src\docs\Ways-of-Working\Contribution-Workflow.mdsrc\docs\Ways-of-Working\Git-Worktrees.mdsrc\docs\Ways-of-Working\PR-Format.mdsrc\docs\Ways-of-Working\Review-Etiquette.mdsrc\docs\Ways-of-Working\Session-Interactions.mdNo workflow, issue-guidance page, shared index, governance page, dependency, code, test, or configuration file changes are included. Active #240 code/tests remain outside scope. Front-matter descriptions are the owning inputs for CI-generated indexes; no generated index was edited or committed.
Concrete before and after
MSX classifies changes at the PR level via labels and the change-type field.MSX classifies changes in the PR according to [PR Format](PR-Format.md).The independent source for the classification correction is the fixed per-result classification contract. Its release decisions remain conditional on the target route. This correction points to that owner rather than inventing a field or repeating its classification rules.
Verification and its limits
The editorial expectations and failing before-text examples were recorded in the native Task before editing. The classification correction also has a source-bound before/expected result recorded before its edit. An exact whole-file comparison proves that only the specified sentence changed against the prior verified head. The other six pages are unchanged from that head, including all actual conditional release-label rules and both unresolved policy choices.
Final comparison against the fixed baseline retains all titles, 95 headings, 14 fenced blocks, 145 inline-code spans, 15 uppercase normative tokens, eight exact interaction phrases, and seven exact aliases/examples. All 72 existing link targets remain intact; the canonical PR-format pointer adds one relative target, for 73 total. PR Format remains wholly unchanged. Four selected policy clauses remain exact. The former field assertion is an explicitly verified descriptive correction, not a preserved policy choice.
The complete before/after prose was reviewed for retained technical meaning, active voice, conditions, direct work steps, and the relevant Issue 9 rules and dictionary. Counts, syntax comparison, linter success, and automated approval do not prove full STE conformance. The ruleset requirements remain normative guidance, not evidence that repository enforcement was audited. The preserved setup/cleanup examples were not executed as real repository operations.
git diff --checkagainst the fixed basemarkdownlint-cli20.24.0 with the shared configurationTest-DocumentationLink.ps1Test-CrossRepositoryLink.ps1Invoke-PesterSuite.ps1with installed Pester 6.0.1python -m zensical build --cleanfromsrc5aa044a68db7f5bcf7927d1d1b48b2bbb1e701fd, reports approval, and adds zero inline comments. There are zero inline comments on the PR. Earlier clean rounds do not validate this new source.Final external evidence: Docs CI, cross-repository CI, and the final source-bound review.
Standards and scope alignment
Criteria were derived before page review from the fixed Documentation Model, Natural Language, Technical Writing Guide, Markdown, Documentation, and applicable Standard/Guide/Reference templates. The official STEMG overview and FAQ and relevant local Issue 9 rules/dictionary were consulted. The source links and verified PDF MD5 are in #261. The PDF and extract remain local and are not republished.
src\docs\Ways-of-Working\Branching-and-Merging.mdsrc\docs\Ways-of-Working\Commit-Conventions.mdsrc\docs\Ways-of-Working\Contribution-Workflow.mdsrc\docs\Ways-of-Working\Git-Worktrees.mdsrc\docs\Ways-of-Working\Review-Etiquette.mdsrc\docs\Ways-of-Working\Session-Interactions.mdThese results cover the scoped prose, not a claim that every policy ambiguity is resolved. Accepted differences include direct imperatives, exact commands/examples, native issue types and technical terms, stable headings/anchors, recognized phrases, and release/history record semantics. The app-managed branch name and the draft-only handoff are explicit campaign exceptions to the general delivery procedure.
The scoped convergence search covered this Task and open MSXOrg/docs issues with
contributionin the title. It returned only #261. The narrow correction delivers the same Task, adds no other closing reference, and does not expand scope. All scoped implementation and repeated verification steps are complete; the Task remains open for review and merge.The inspected target workflows build and publish the Zensical site. They do not invoke Release Management or publish a versioned product artifact. No publication baseline, release decision block, or applied release label is appropriate for this PR. Its scoped source comparison is not release-note coverage evidence.
Preserved policy questions and handoff
Only two genuine policy tensions remain unresolved: Session Interactions calls Stop the only interaction that MUST confirm first, while Spin-off also requires confirmation; Review Etiquette sends self-review to the terminal but also describes a public
Commentreview. Their original source clauses remain unchanged. The unsupported change-type-field reference is resolved from canonical PR Format as a narrow descriptive correction, not left as a third policy question.There is no remaining implementation or validation blocker. This campaign stops at draft. The PR is open, draft, and unmerged; GitHub auto-merge is unset and Agent merge is disabled. Do not mark ready, merge, or enable either merge feature.
Related references