|
1 | 1 | # Agents |
2 | 2 |
|
3 | | -This repository is the central documentation for the MSX ecosystem. Everything an agent needs to work here — and the roles agents play across the ecosystem — is documentation, read the same way a new teammate would. |
| 3 | +## Main directive |
4 | 4 |
|
5 | | -## Start here |
| 5 | +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. |
6 | 7 |
|
7 | | -1. Read this file, then the [README](README.md) for what this repository is and how it builds. |
8 | | -2. Read the [Ways of Working](https://msxorg.github.io/docs/Ways-of-Working/) — how work flows from idea to delivery. |
9 | | -3. Load the [Coding Standards](https://msxorg.github.io/docs/Coding-Standards/) relevant to the change. |
| 8 | +## Install the ecosystem |
10 | 9 |
|
11 | | -## Roles |
| 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 all branches - worktree = name of the branch. |
| 15 | + 2. <https://github.com/MSXOrg/memory/> — work directly towards main. |
| 16 | + - Simple clone, only main. |
12 | 17 |
|
13 | | -Agent behaviour is authored once, as documentation, in the [Agents](https://msxorg.github.io/docs/Agents/) section. Use the role that fits the task: |
| 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. |
14 | 21 |
|
15 | | -- [Define](https://msxorg.github.io/docs/Agents/define/) — capture, refine, and plan a change into an issue. |
16 | | -- [Implement](https://msxorg.github.io/docs/Agents/implement/) — deliver a planned issue as a review-ready pull request. |
17 | | -- [Reviewer](https://msxorg.github.io/docs/Agents/reviewer/) — review a pull request for delivery, taste, and security. |
18 | | -- [Security Reviewer](https://msxorg.github.io/docs/Agents/security-reviewer/) — a structured, defensive security pass. |
19 | | -- [Agent Author](https://msxorg.github.io/docs/Agents/agent-author/) — create and maintain these roles and pointers. |
| 22 | +## Working with the ecosystem |
20 | 23 |
|
21 | | -## How work happens here |
22 | | - |
23 | | -- [Branching and Merging](https://msxorg.github.io/docs/Ways-of-Working/Branching-and-Merging/) and [Git Worktrees](https://msxorg.github.io/docs/Ways-of-Working/Git-Worktrees/) — the branch model and where to work. |
24 | | -- [Contribution Workflow](https://msxorg.github.io/docs/Ways-of-Working/Contribution-Workflow/) — the draft-first, Copilot-review loop through to a ready pull request. |
25 | | -- [Definition of Ready and Done](https://msxorg.github.io/docs/Ways-of-Working/Definition-of-Ready-and-Done/) — when a change is ready for review and when it lands. |
26 | | -- This repository's build and checks — see the [README](README.md). |
27 | | - |
28 | | -## The rule |
29 | | - |
30 | | -This file points; it never defines. Process knowledge lives in the docs and is referenced by canonical URL — never copied here. See [Agentic Development](https://msxorg.github.io/docs/Ways-of-Working/Agentic-Development/). |
| 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 the `.msx/main/docs` - start with the index to get an overview of what is here. |
| 28 | +3. Read the `.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. |
0 commit comments