feat: add agent instructions document with operational guidelines
Browse files
AGENTS.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Agent Instructions
|
| 2 |
+
|
| 3 |
+
This document outlines the operational guidelines and standards for agents working in this workspace.
|
| 4 |
+
|
| 5 |
+
## 1. Language Standards
|
| 6 |
+
|
| 7 |
+
- Code & Comments: All comments, documentation strings (docstrings), and variable names in source code files (everything outside the `docs/` directory) must be written in English.
|
| 8 |
+
- Documentation: Files within the `docs/` directory may be written in the user's preferred language (e.g., Japanese).
|
| 9 |
+
|
| 10 |
+
## 2. Package Management
|
| 11 |
+
|
| 12 |
+
- Tool: Use uv as the Python package manager for this project.
|
| 13 |
+
|
| 14 |
+
## 3. Task Documentation Workflow
|
| 15 |
+
|
| 16 |
+
When receiving a request that is neither a simple question nor a single-step task, follow this workflow:
|
| 17 |
+
|
| 18 |
+
### Create Task Document
|
| 19 |
+
|
| 20 |
+
- Create a new markdown file in the `docs/tasks/` directory.
|
| 21 |
+
- Naming convention: `YYYYMMDD_{sequence}.md` (e.g., `20251123_01.md`, `20251123_02.md`).
|
| 22 |
+
- This file is referred to as the "Task Document".
|
| 23 |
+
|
| 24 |
+
### Content Requirements
|
| 25 |
+
|
| 26 |
+
- Language: Write the content in the language the user is currently using.
|
| 27 |
+
- Breakdown: Decompose the requested task into specific, actionable steps.
|
| 28 |
+
|
| 29 |
+
### User Confirmation
|
| 30 |
+
|
| 31 |
+
- CRITICAL: After creating the Task Document and BEFORE starting any implementation work, you must present the plan to the user and ask for confirmation that the approach is correct.
|
| 32 |
+
|
| 33 |
+
### Maintenance
|
| 34 |
+
|
| 35 |
+
- Continuously update and edit the Task Document to reflect progress, changes in requirements, or additional information discovered during execution.
|