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
Every permission in that block is required. GitHub App installation tokens perform repository writes. A push to `main` publishes a stable release after the full pipeline passes;
74
-
the pull-request trigger handles CI, prereleases, and prerelease cleanup. See
75
-
[Workflow inputs](../reference/workflow-inputs.md) for what each permission is used for, and
76
-
[Calling the workflow](../guides/calling-the-workflow.md) for passing test secrets and variables.
Copy file name to clipboardExpand all lines: docs/content/guides/validating-before-review.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ Do not repeat the shared workflow here. Follow the shared branch → draft PR
78
78
Check:
79
79
80
80
- naming, documentation, error handling, testing expectations, and security posture align with the relevant pages under [MSX Coding Standards](https://msx.no/docs/Coding-Standards/)
81
-
- the change follows the shared "written once, referenced everywhere" rule by linking canonical guidance instead of copying it into local docs or code comments, as described in [Agentic Development](https://msx.no/docs/Ways-of-Working/Agentic-Development/)
81
+
- the change follows the shared "written once, referenced everywhere" rule by linking canonical guidance instead of copying it into local docs or code comments, as described in [Agentic Development](https://msx.no/docs/Capabilities/agentic-development/)
82
82
- the draft PR description, issue progress, and any follow-up issues reflect what actually shipped and what still belongs out of scope
83
83
84
84
This is the last author-side gate before a PSModule draft PR is ready for independent review.
Name the caller file `Process-PSModule.yml`, matching [`PSModule/Template-PSModule`](https://github.com/PSModule/Template-PSModule) and every existing module repository. `workflow.yml` is the reusable workflow's own filename inside `PSModule/Process-PSModule` and belongs only in the `uses:` reference. Pin the reference to a commit SHA with the version tag in a trailing comment so Dependabot can update it.
134
+
Name the caller file `Process-PSModule.yml`. `workflow.yml` is the reusable
135
+
workflow's own filename inside `PSModule/Process-PSModule` and belongs only in
136
+
the `uses:` reference. Process-PSModule is initiative-owned automation with a
137
+
controlled release process, so the template uses the floating `@v8` major
138
+
reference permitted by the MSX GitHub Actions standard.
141
139
142
140
## Required common files
143
141
@@ -160,7 +158,8 @@ Required baseline files for module repositories:
160
158
|`.github/SUPPORT.md`| Support channel and issue-routing expectations. |
161
159
|`.github/CODE_OF_CONDUCT.md`| Community participation rules. |
162
160
|`AGENTS.md`| Cross-tool agent instructions pointing to the canonical guidance at `https://psmodule.io/Process-PSModule/`. |
163
-
| `CLAUDE.md` | Claude Code entry point that imports `AGENTS.md`. |
161
+
|`.claude/CLAUDE.md`| Claude Code entry point that imports the root `AGENTS.md`. |
162
+
|`.github/copilot-instructions.md`| Route to `AGENTS.md` for Copilot surfaces that need their own filename. |
164
163
|`.github/dependabot.yml`| Configures ecosystem-appropriate dependency-update pull requests. For PowerShell module repositories the `github-actions` ecosystem is expected; add any other ecosystems the module actually develops in. |
165
164
|`.github/CODEOWNERS`| Review routing for source, docs, and GitHub workflow files. |
166
165
|`.github/pull_request_template.md`| Scaffolds pull requests in the MSX PR Format (PR Manager) style — an icon + change-type + user-facing-outcome title, user-facing description sections, an optional technical-details block, and a related-issues block. |
@@ -185,13 +184,25 @@ community health files.
185
184
Every repository must be usable by an agent that has never seen it before, without special configuration. Each repository carries its own agent entry points that point to the authoritative documentation instead of restating it:
186
185
187
186
-`AGENTS.md`: the cross-tool entry point, read by the GitHub Copilot coding agent, VS Code, and other AGENTS.md-aware tools. It names what the repository is in a line or two and points to the canonical agent guidance at [psmodule.io/Process-PSModule](https://psmodule.io/Process-PSModule/).
188
-
- `CLAUDE.md`: a thin file that imports `AGENTS.md` with `@AGENTS.md` so Claude Code reads the same instructions. Claude-specific notes, if any, go below the import.
189
-
190
-
See [PSModule/Template-PSModule](https://github.com/PSModule/Template-PSModule) for a concrete implementation example of `AGENTS.md` and `CLAUDE.md`.
191
-
192
-
`AGENTS.md`and `CLAUDE.md` are the required set. `AGENTS.md` is the entry point that AGENTS.md-aware runtimes read directly, so a repository is usable by an agent without a per-runtime copy of the same pointer.
193
-
194
-
Runtime-specific adapter files such as `.github/copilot-instructions.md` and `.github/instructions/*.instructions.md` are optional. MSX treats them as client adapters that *may* add runtime-specific loading or path rules, described in [Agentic Development](https://msx.no/docs/Ways-of-Working/Agentic-Development/) and its [capability specification](https://msx.no/docs/Capabilities/agentic-development/spec/). Add one when a runtime needs loading or path rules that `AGENTS.md` cannot express, and keep it pointing at `AGENTS.md` rather than restating it. `Template-PSModule` ships without one.
187
+
-`.claude/CLAUDE.md`: a thin file that imports the root router with
188
+
`@../AGENTS.md`.
189
+
-`.github/copilot-instructions.md`: a thin link to `../AGENTS.md` for Copilot
190
+
surfaces that do not read the root router directly.
191
+
192
+
See [PSModule/Template-PSModule](https://github.com/PSModule/Template-PSModule)
193
+
for the concrete implementation.
194
+
195
+
`AGENTS.md`, `.claude/CLAUDE.md`, and
196
+
`.github/copilot-instructions.md` are the required set. `AGENTS.md` is the
197
+
entry point that AGENTS.md-aware runtimes read directly.
198
+
199
+
Additional runtime-specific adapters and
200
+
`.github/instructions/*.instructions.md` are optional. MSX treats them as
201
+
client routes or path-scoped caveats, described in
Keep routes pointing at `AGENTS.md` rather than restating it.
195
206
196
207
These files are the agent equivalent of the README: pointers, not copies. Keep them short so the linked documentation stays the single source of truth. Like the other governance files, they live in the repository itself so it can stand on its own.
0 commit comments