|
1 | 1 | <h1 align="center">AgentGo</h1> |
2 | 2 |
|
3 | 3 | <p align="center"> |
4 | | - <strong>Drop in one AGENTS.md. Go agent-ready.</strong> |
| 4 | + <strong>One AGENTS.md makes any project agent-ready.</strong> |
5 | 5 | </p> |
6 | 6 |
|
7 | 7 | <p align="center"> |
8 | | - <sub>Best practices baked in — works in every project.</sub> |
| 8 | + <sub>Best practices baked in. No custom setup required.</sub> |
9 | 9 | </p> |
10 | 10 |
|
11 | 11 | <p align="center">English | <a href="./README.zh-CN.md">简体中文</a></p> |
@@ -133,7 +133,7 @@ flowchart LR |
133 | 133 | style D fill:#B45309,color:#fff |
134 | 134 | ``` |
135 | 135 |
|
136 | | -New findings are filed by type: source document inventory → `memory/source-index.md`, project conventions → `rules/`, decisions → `memory/decisions.md`, gotchas → `memory/gotchas.md`, reusable patterns → `memory/patterns.md`, review findings → `memory/review-findings.md`, and unresolved work → `memory/open-items.md`. After each meaningful task, the agent records durable results and appends `.agents/changelog.md`. The maintenance cadence is enforced by `AGENTS.md` itself — **easy to write in, hard to stay** — so notes never pile up into noise. |
| 136 | +New findings are filed by type: source document inventory → `memory/source-index.md`, project conventions → `rules/`, decisions → `memory/decisions.md`, gotchas → `memory/gotchas.md`, reusable patterns → `memory/patterns.md`, reusable workflows → `workflows/`, runtime-supported skills → `skills/` when useful, review findings → `memory/review-findings.md`, and unresolved work → `memory/open-items.md`. After each meaningful task, the agent records durable results and appends `.agents/changelog.md`. The maintenance cadence is enforced by `AGENTS.md` itself — **easy to write in, hard to stay** — so notes never pile up into noise. |
137 | 137 |
|
138 | 138 | Recommended memory entry shape: `date`, `artifact`, `note`, `evidence`, `status`, and `next action`. The project does not need git; when no git repository exists, `.agents/changelog.md` still acts as the local audit trail. |
139 | 139 |
|
@@ -170,6 +170,7 @@ your-project/ |
170 | 170 | │ ├── memory/ # Project overview, decisions, findings, open items |
171 | 171 | │ ├── rules/ # Project conventions extracted from artifacts/config |
172 | 172 | │ ├── workflows/ # Standard operating procedures for recurring flows |
| 173 | +│ ├── skills/ # Optional repo-scoped skills for supporting runtimes |
173 | 174 | │ ├── archive/ # Obsolete agent-only configs, only after confirmation |
174 | 175 | │ └── changelog.md # Audit log of changes to .agents/ |
175 | 176 | ├── docs/archive/ ← Optional human-doc archive, only if the project uses it |
@@ -211,6 +212,7 @@ A clear boundary between human control and agent autonomy: |
211 | 212 | | Project notes, decisions, gotchas | `memory/` | Agent writes, merges, prunes freely | |
212 | 213 | | Project conventions and reusable patterns | `rules/` | Agent writes freely; deletion needs user confirmation | |
213 | 214 | | Complex workflows | `workflows/` | Agent writes freely; deletion needs user confirmation | |
| 215 | +| Runtime-supported skills | `skills/` | Optional focused workflows; deletion needs user confirmation | |
214 | 216 | | Source document inventory | `.agents/memory/source-index.md` | Agent indexes active project references | |
215 | 217 | | Obsolete agent-only configs | `.agents/archive/` | **Archived only after user confirmation** | |
216 | 218 | | Obsolete human-facing docs | Project docs archive, e.g. `docs/archive/` | **Archived only after user confirmation** | |
@@ -239,7 +241,7 @@ A clear boundary between human control and agent autonomy: |
239 | 241 | <details> |
240 | 242 | <summary><strong>Should I commit .agents/ to git?</strong></summary> |
241 | 243 |
|
242 | | -It depends. For personal projects, gitignore the whole `.agents/` — it's your private working memory. For team projects, commit static config (`rules/`, `workflows/`) to share team conventions, but gitignore dynamic data (`memory/`) since it's session-level. `AGENTS.md` itself should always be committed — it's the contract between project and agent. |
| 244 | +It depends. For personal projects, gitignore the whole `.agents/` — it's your private working memory. For team projects, commit static config (`rules/`, `workflows/`, optionally `skills/`) to share team conventions, but gitignore dynamic data (`memory/`) since it's session-level. `AGENTS.md` itself should always be committed — it's the contract between project and agent. |
243 | 245 |
|
244 | 246 | Common team pattern: |
245 | 247 | ```gitignore |
|
0 commit comments