38 lines
1.3 KiB
Markdown
38 lines
1.3 KiB
Markdown
# Workspace Agent Instructions
|
|
|
|
## Folder Structure & Purpose
|
|
|
|
- `ai-agent`: Agent workspace for internal notes, chat logs, and todo lists.
|
|
- `code`: Ground truth for all program code. Only source files belong here.
|
|
- `documentation`: User-facing documentation in Markdown format.
|
|
- `tests`: Unit tests only.
|
|
|
|
**Strict separation:**
|
|
- Agent materials → `ai-agent`
|
|
- Source code → `code`
|
|
- Documentation → `documentation`
|
|
- Tests → `tests`
|
|
|
|
## Agent Workflow Principles
|
|
|
|
- Always respect folder boundaries and intended purposes.
|
|
- Never mix code, docs, tests, or agent materials across folders.
|
|
- When generating new files, place them in the correct folder by type.
|
|
- When updating instructions, preserve valuable content and remove outdated or duplicate sections.
|
|
|
|
## Anti-Patterns
|
|
|
|
- Do not store code, documentation, or tests in `ai-agent`.
|
|
- Do not place agent notes, logs, or todos in `code`, `documentation`, or `tests`.
|
|
- Do not duplicate content across folders.
|
|
|
|
## Example Prompts
|
|
|
|
- "Create a new script in `code` for data processing."
|
|
- "Add a Markdown guide to `documentation` explaining the backup process."
|
|
- "Write unit tests for the backup logic in `tests`."
|
|
- "Store my agent notes in `ai-agent`."
|
|
|
|
---
|
|
|
|
For advanced customization, use applyTo-based instructions for specific areas (e.g., frontend, backend, tests) as the project grows. |