mirror of
https://github.com/agno-agi/agno.git
synced 2026-10-12 02:10:54 +00:00
AGENTS.md
This commit is contained in:
@@ -122,29 +122,6 @@ Format:
|
||||
|
||||
---
|
||||
|
||||
## Design Documents
|
||||
|
||||
The `specs/` folder contains design documents for ongoing initiatives.
|
||||
|
||||
**Always read the design document first**.
|
||||
|
||||
Each spec follows this structure:
|
||||
```
|
||||
specs/agno/<spec-name>/
|
||||
├── design.md # The specification
|
||||
├── implementation.md # Current status and what's done
|
||||
├── prompts.md # Prompts used for testing
|
||||
└── notes.md # Notes on the design and implementation
|
||||
```
|
||||
|
||||
**Workflow:**
|
||||
1. Read `design.md` to understand what we're building
|
||||
2. Check `implementation.md` for current status
|
||||
3. Find the relevant code in `libs/agno`
|
||||
4. Create/update cookbooks to test patterns
|
||||
|
||||
---
|
||||
|
||||
## Code Locations
|
||||
|
||||
| What | Where |
|
||||
@@ -222,8 +199,8 @@ Both scripts must pass with no errors before code review.
|
||||
**PR Title Format:**
|
||||
|
||||
PR titles must follow one of these formats:
|
||||
- `[type] description` — e.g., `[feat] add workflow serialization`
|
||||
- `type: description` — e.g., `feat: add workflow serialization`
|
||||
- `[type] description` — e.g., `[feat] add workflow serialization`
|
||||
- `type-kebab-case` — e.g., `feat-workflow-serialization`
|
||||
|
||||
Valid types: `feat`, `fix`, `cookbook`, `test`, `refactor`, `chore`, `style`, `revert`, `release`
|
||||
|
||||
@@ -82,11 +82,8 @@ Apart from implementing features, your most important task will be to test and m
|
||||
|
||||
Each cookbook folder should have the following files:
|
||||
- `README.md` — The README for the cookbook.
|
||||
- `CLAUDE.md` — Project-specific instructions (most cookbooks won't have this yet).
|
||||
- `TEST_LOG.md` — Test results log.
|
||||
|
||||
When testing a cookbook folder, first check for the `CLAUDE.md` file. If it doesn't exist, ask the user if they'd like you to create it. Use `cookbook/08_learning/CLAUDE.md` as a reference.
|
||||
|
||||
### Testing Workflow
|
||||
|
||||
**1. Before Testing**
|
||||
@@ -125,32 +122,6 @@ Format:
|
||||
|
||||
---
|
||||
|
||||
## Design Documents
|
||||
|
||||
The `specs/` folder contains design documents for ongoing initiatives. If you're working on one of the following:
|
||||
- `specs/learning-machine/` — Unified learning system for agents
|
||||
|
||||
**Always read the design document first**.
|
||||
|
||||
Each spec follows this structure:
|
||||
```
|
||||
specs/<spec-name>/
|
||||
├── CLAUDE.md # Spec-specific instructions (read this first)
|
||||
├── design.md # The specification
|
||||
├── implementation.md # Current status and what's done
|
||||
├── decisions.md # Why decisions were made
|
||||
└── future-work.md # What's deferred
|
||||
```
|
||||
|
||||
**Workflow:**
|
||||
1. Read the spec's `CLAUDE.md` for specific instructions
|
||||
2. Read `design.md` to understand what we're building
|
||||
3. Check `implementation.md` for current status
|
||||
4. Find the relevant code in `libs/agno`
|
||||
5. Create/update cookbooks to test patterns
|
||||
|
||||
---
|
||||
|
||||
## Code Locations
|
||||
|
||||
| What | Where |
|
||||
@@ -228,8 +199,8 @@ Both scripts must pass with no errors before code review.
|
||||
**PR Title Format:**
|
||||
|
||||
PR titles must follow one of these formats:
|
||||
- `[type] description` — e.g., `[feat] add workflow serialization`
|
||||
- `type: description` — e.g., `feat: add workflow serialization`
|
||||
- `[type] description` — e.g., `[feat] add workflow serialization`
|
||||
- `type-kebab-case` — e.g., `feat-workflow-serialization`
|
||||
|
||||
Valid types: `feat`, `fix`, `cookbook`, `test`, `refactor`, `chore`, `style`, `revert`, `release`
|
||||
|
||||
Reference in New Issue
Block a user