Skip to content

Commit 0559510

Browse files
Add copy-pasteable AGENTS.md/CLAUDE.md/copilot-instructions.md examples
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 59ffc92 commit 0559510

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

src/docs/Modules/Repository-Defaults.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,34 @@ Every repository must be usable by an agent that has never seen it before, witho
138138

139139
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.
140140

141+
### Example
142+
143+
`AGENTS.md`:
144+
145+
```markdown
146+
# Agents
147+
148+
This repository is a PowerShell module built with the [PSModule](https://github.com/PSModule) framework.
149+
150+
- Read this repository's own [README](README.md) and [CONTRIBUTING](CONTRIBUTING.md) first.
151+
- For module layout, build/test/pack/publish behavior, and repository conventions, see
152+
[PSModule/docs](https://psmodule.io/docs/), starting with
153+
[Process-PSModule](https://psmodule.io/docs/Modules/Process-PSModule/).
154+
- For org-wide coding standards and ways of working, see [MSXOrg/docs](https://msxorg.github.io/docs/).
155+
```
156+
157+
`CLAUDE.md`:
158+
159+
```markdown
160+
@AGENTS.md
161+
```
162+
163+
`.github/copilot-instructions.md`:
164+
165+
```markdown
166+
Follow the instructions in [AGENTS.md](../AGENTS.md).
167+
```
168+
141169
## Managed file distribution
142170

143171
Shared repository files are managed through [`PSModule/Distributor`](https://github.com/PSModule/Distributor). Distributor is the source of truth for managed file content and file-set membership.

0 commit comments

Comments
 (0)