You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
π [Docs]: Ways of working now follows the canonical issue model (#97)
Ways of Working now treats Epic and PBI as planning aggregates while
Task and Bug delivery leaves own implementation and pull-request
closure. Workflow is the single process entry point, and ordinary stage
procedures live under Ways of Working.
## Changed: Agent setup remains actionable
`AGENTS.md` retains the complete agent-only installation and operating
contract: improvement/escalation, ecosystem setup, local identity,
README/CONTRIBUTING orientation, worktree discipline, micro-commits,
push-every-commit, and MSXOrg memory's direct-main policy.
## Changed: Docs use bare backing plus canonical worktree
Each docs repository uses `docs.git` as a bare backing repository and
`docs` as its clean readable default-branch worktree. Missing installs
create that topology directly. Safe simple clones migrate with local
branches/tags verified and a retained backup; canonical and legacy
worktrees are reused; unsafe states fail with rollback/actionable
guidance. Memory remains a simple checkout.
## Changed: Refresh-first discovery is enforced
The copied bootstrap seed refreshes and proves an existing bare default
branch before creating/loading the canonical worktree. The full
bootstrap then validates every configured context repository before any
index traversal.
---
<details>
<summary>Technical details</summary>
- Makes `Workflow.md` the sole process and stage-routing owner.
- Moves stage procedures to `Ways-of-Working/Workflow-Stages/`.
- Restores all material root AGENTS policy without copying stages.
- Aligns Git Worktrees and bootstrap on sibling `docs.git` + `docs`
topology.
- Preserves branches/tags during simple-clone migration and rolls back
failures.
- Tests the executable Markdown seeds and all supported/unsafe topology
states hermetically.
</details>
<details>
<summary>Relevant issues (or links)</summary>
- Fixes#86
</details>
---------
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Everything is a work in progress and can be updated and improved.
6
-
If you find a problem, fix it if it's small; otherwise, register it as an issue in the respective repo.
5
+
Everything is a work in progress and can be updated and improved. Fix a small problem when it is directly in scope; register a larger or unrelated problem as an issue in the repository that owns it.
7
6
8
-
## Install the ecosystem
7
+
This repository belongs to `github.com/MSXOrg`.
9
8
10
-
1. Create a folder in the home directory called `.msx`:
11
-
2. Clone the ecosystem locally:
12
-
1.<https://github.com/MSXOrg/docs> β requires PRs to be updated.
13
-
- Clone as bare and use worktrees.
14
-
- Create a worktree for every branch. Use a concise `<issue>-<slug>` worktree folder for a topic branch named `<type>/<issue>-<slug>`.
15
-
2.<https://github.com/MSXOrg/memory/> β work directly towards main.
16
-
- Simple clone, only main.
9
+
## Install and synchronize the ecosystem
17
10
18
-
To install:
19
-
- Clone the repos in the users home folder under a sub-folder named `.msx`.
20
-
- Set configs locally to each of these repos using the GitHub username and email.
11
+
The agent workspace lives under `~/.msx`:
21
12
22
-
## Working with the ecosystem
13
+
| Repository | Local path | Purpose | Change model |
14
+
| --- | --- | --- | --- |
15
+
|`MSXOrg/docs`|`~/.msx/docs.git` + `~/.msx/docs`| Bare backing repository plus clean readable main worktree for reviewed organization context. | Pull requests through topic worktrees only. |
16
+
|`MSXOrg/memory`|`~/.msx/memory`| Durable organization memory: prior decisions, gotchas, and reusable working knowledge. | Commit and push directly to `main`, per that repository's policy. |
23
17
24
-
1. Get to know this repo first:
25
-
-[README](README.md) for what this repository is and how it builds.
26
-
-[CONTRIBUTING](CONTRIBUTING.md) for how to contribute and the review process.
27
-
2. Read `~/.msx/docs` - start with the index to get an overview of what is here.
28
-
3. Read `~/.msx/memory` - start with the index to get an overview of what is here. Use this while working - commit your memories here for work inside the PSModule organization.
29
-
4. While working with the code, do small micro commits and push on every commit. This will make it easier to review and merge your changes.
18
+
From this repository, install missing context repositories and synchronize every existing clone before use:
19
+
20
+
```powershell
21
+
pwsh bootstrap/Initialize-MsxWorkspace.ps1 `
22
+
-UserName '<github-user>' `
23
+
-UserEmail '<github-noreply-email>'
24
+
```
25
+
26
+
Projects that add their own docs and memory provide plug-in coordinates without changing the synchronization implementation:
The bootstrap writes identity only to each context repository's local git configuration. It must succeed before any context is read; do not continue with missing, dirty, diverged, wrong-branch, unreachable, or stale context.
47
+
48
+
Use a dedicated worktree for every topic branch. Follow [Git Worktrees](src/docs/Ways-of-Working/Git-Worktrees.md) for the local layout and [Branching and Merging](src/docs/Ways-of-Working/Branching-and-Merging.md) for `<type>/<issue>-<slug>` branch names.
1. Segment the work by host, organization, repository, path, and task.
58
+
2. Synchronize every canonical context repository to its remote default branch; stop if any context may be stale.
59
+
3. Start at the docs root index and follow [Ways of Working](src/docs/Ways-of-Working/index.md) to the canonical [Workflow](src/docs/Ways-of-Working/Workflow.md).
60
+
4. Infer the current stage from the task and its artifacts, then read the linked stage procedure.
61
+
5. Read [README.md](README.md), [CONTRIBUTING.md](CONTRIBUTING.md), relevant standards, and organization memory.
62
+
6. Apply path-specific local rules only when they match the files in scope.
63
+
64
+
## Working in this repository
65
+
66
+
1. Use [README.md](README.md) to understand what this repository is and how it builds.
67
+
2. Use [CONTRIBUTING.md](CONTRIBUTING.md) for its contribution and review contract.
68
+
3. Keep work reviewable with small, descriptive micro-commits.
69
+
4. Push every commit so the remote branch, CI, and draft pull request reflect current work.
70
+
5. Improve organization memory when a verified lesson is likely to matter again; commit and push MSXOrg memory directly to `main`.
71
+
72
+
This file owns bootstrap and repository-specific operating instructions. The linked documentation owns reusable process knowledge; this file does not redefine a workflow stage, coding standard, or review convention.
The single starting point for any agent, in any repository. Before doing anything else, make sure the central workspace exists locally, then read from it.
4
4
5
+
## Main directive
6
+
7
+
Everything is a work in progress and can be updated and improved. Fix a small problem when it is directly in scope; register a larger or unrelated problem as an issue in the repository that owns it.
8
+
5
9
## First β bootstrap the workspace
6
10
7
-
The workspace is a git-isolated clone of the central repositories under `~/.msx`. Set it up (idempotent β clones what is missing, attempts to fast-forward the rest):
11
+
The workspace is a git-isolated clone of the central repositories under `~/.msx`. Set it up before reading context. Existing context repositories must be clean, on their default branch, and exactly synchronized with the remote:
throw "Context synchronization failed. Do not read context until every project is current."
124
+
}
22
125
```
23
126
127
+
Keep the MSXOrg entry and add only the additional project coordinates required by repositories that inherit this template. Every project reuses the same synchronization and validation implementation.
128
+
24
129
This produces:
25
130
26
-
-`~/.msx/docs` β how work is done: ways of working, coding standards, and agent roles. The same content published at <https://msxorg.github.io/docs/>.
131
+
-`~/.msx/docs.git` β bare backing repository for central docs.
132
+
-`~/.msx/docs` β clean, readable main worktree containing ways of working, standards, and workflow guidance.
27
133
-`~/.msx/memory` β what has been learned before: durable notes and prior session context.
28
134
29
135
Each clone has repository-local git config only; it never modifies the global git config or the repository being worked in (git still reads them, but only repository-local config is written).
@@ -32,10 +138,22 @@ Each clone has repository-local git config only; it never modifies the global gi
32
138
33
139
## Then β read before acting
34
140
35
-
1. Read the relevant pages under `~/.msx/docs` for the task at hand.
36
-
2. Read `~/.msx/memory` for prior decisions, pitfalls, and context.
141
+
1. Start at `~/.msx/docs/src/docs/index.md`.
142
+
2. Follow the Ways of Working index to `Workflow.md`.
143
+
3. Infer the current stage from the task and its artifacts, then read the linked stage procedure.
144
+
4. Read the relevant standards, repository context, and `~/.msx/memory`.
145
+
146
+
Clear task language may shortcut the index trail: `Review this PR <link>` enters Review, `Make this issue <description>` enters Define, and `Implement <issue>` enters Implement. The linked documentation owns each procedure; this file does not define a separate agent or skill.
147
+
148
+
## Work in the selected repository
149
+
150
+
1. Read its `README.md` to understand the repository and its build.
151
+
2. Read its `CONTRIBUTING.md` for the contribution and review contract.
152
+
3. Use a dedicated worktree and the branch naming defined by the canonical Ways of Working.
153
+
4. Make small, descriptive micro-commits and push every commit so remote state, CI, and the draft pull request stay current.
154
+
5. Capture verified reusable lessons in organization memory, following that repository's own instructions.
37
155
38
156
## Two write rules
39
157
40
-
-**Docs change through pull requests.**Branch inside `~/.msx/docs` and open a pull request; never push its `main`.
41
-
-**Memory pushes to main.**Commit and push notes directly inside `~/.msx/memory`; no pull request.
158
+
-**Docs change through topic worktrees and pull requests.**Create a topic worktree from `~/.msx/docs.git`; never branch or work inside the canonical `~/.msx/docs` main worktree.
159
+
-**Memory follows repository policy.**Read the selected memory repository's `AGENTS.md` and `CONTRIBUTING.md` before writing.
0 commit comments