Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,36 @@ Before creating ANY pull request, verify:
- ✅ NOT targeting: `rlabbe/filterpy` (FORBIDDEN)
- ✅ Base branch is set correctly for this fork
- ✅ You are NOT attempting to contribute upstream

## 📝 Agent Documentation Guidelines

### Where to Write Documentation

When agents need to create documentation files (design docs, analysis reports, guides, etc.), they should **write to the `scratch_files/` directory** instead of the repository root.

**Example:**
- ❌ DON'T: Create `MY_ANALYSIS.md` in root
- ✅ DO: Create `scratch_files/MY_ANALYSIS.md`

### Why?

The repository root should contain only essential documentation files:
- `README.md` - Project overview
- `AGENTS.md` - Agent guidelines (this file)
- Other critical docs

The `scratch_files/` directory is where agents can freely write:
- Analysis and investigation reports
- Design documents
- Planning notes
- Implementation guides
- Troubleshooting docs
- Architecture diagrams
- Any other supporting documentation

### File Naming

Agent-generated documentation in `scratch_files/` can use any naming convention:
- Capitalized markdown files are fine (e.g., `ANALYSIS.md`, `DESIGN.md`)
- Descriptive names are encouraged
- Dates/timestamps are helpful (e.g., `2025-10-25_investigation.md`)
Empty file added scratch_files/.gitkeep
Empty file.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading