|
1 | 1 | # Agents |
2 | 2 |
|
3 | | -## Purpose |
| 3 | +## Main directive |
4 | 4 |
|
5 | | -Use this file to understand how agents should gather context and execute work in |
6 | | -this repository. |
| 5 | +Everything is a work in progress and can be improved. |
| 6 | +If you find a problem or improvement, fix if small; otherwise open an issue. |
7 | 7 |
|
8 | | -## Core operating standard |
| 8 | +## Repo guidance |
9 | 9 |
|
10 | | -1. Treat repository controls (linters, security checks, policies) as correct by |
11 | | - default. |
12 | | -2. Align implementation with controls before considering exceptions. |
13 | | -3. If an exception is needed, make it explicit, minimal, and documented in code |
14 | | - and PR context. Never bypass controls silently. |
| 10 | +- [`README.md`](README.md) — what this repository is and its purpose as the |
| 11 | + Process-PSModule framework. |
15 | 12 |
|
16 | | -## Canonical context resolution |
| 13 | +## PSModule Framework guidance |
17 | 14 |
|
18 | | -Determine repository identity from Git metadata (for example, `origin` remote and |
19 | | -repository settings). Do not hardcode a specific owner or host unless the task |
20 | | -explicitly requires it. |
| 15 | +Regarding repo structure, module source code, and how the Process-PSModule workflow |
| 16 | +works. For PSModule-specific build, layout, and process guidance: |
21 | 17 |
|
22 | | -Process context in this order: |
| 18 | +- [Process-PSModule docs](https://psmodule.github.io/docs/Modules/Process-PSModule/) — |
| 19 | + repository structure, module anatomy, and the build/test/pack/publish pipeline. |
| 20 | +- [Repository defaults](https://psmodule.github.io/docs/Modules/Repository-Defaults/) — |
| 21 | + the expected repository layout and required files. |
| 22 | +- [Standards](https://psmodule.github.io/docs/Modules/Standards/) — PowerShell module |
| 23 | + coding standards. |
| 24 | +- [PSModule/memory](https://github.com/PSModule/memory) — durable cross-session agent |
| 25 | + working memory for the PSModule organization. |
23 | 26 |
|
24 | | -| Order | Source | What to read first | Why | |
25 | | -| --- | --- | --- | --- | |
26 | | -| 1 | Local repository | `README.md`, `CONTRIBUTING.md`, local docs index/start page | Local behavior and contribution rules are authoritative for this repo. | |
27 | | -| 2 | Project/framework guidance | Framework or shared project docs referenced by this repo | Align with shared implementation patterns used by sibling repos. | |
28 | | -| 3 | Central organization guidance | Organization-level docs and standards | Apply global policy after local/project specifics are known. | |
| 27 | +## Org-wide guidance |
29 | 28 |
|
30 | | -## Documentation standards for commands and repos |
| 29 | +For cross-cutting ways of working and standards: |
31 | 30 |
|
32 | | -1. Use canonical repository URLs in docs (full URLs such as |
33 | | - `https://github.com/owner/repo`) instead of ambiguous short names. |
34 | | -2. For install and synchronization instructions, provide equivalent examples for |
35 | | - native shells on Windows, macOS, and Linux. |
| 31 | +- [Agentic Development](https://msxorg.github.io/docs/Ways-of-Working/Agentic-Development/) — |
| 32 | + how agents and humans collaborate in this ecosystem. |
| 33 | +- [Ways of Working](https://msxorg.github.io/docs/Ways-of-Working/) — contribution |
| 34 | + workflow, branching, PRs, issues. |
| 35 | +- [Coding Standards](https://msxorg.github.io/docs/Coding-Standards/) — language-level |
| 36 | + conventions. |
| 37 | +- [MSXOrg/memory](https://github.com/MSXOrg/memory) — durable agent working memory: |
| 38 | + gotchas, knowledge, and agent role notes. |
0 commit comments