feat: introduce AI agent framework and task tooling
- add AGENT.md describing the agent system - add AGENT_WORKFLOW.md defining the execution workflow - add AI_TASK_TEMPLATE.md for structured task prompts - add scripts/ai-task CLI tool for generating standardized agent tasks
This commit is contained in:
145
AI_TASK_TEMPLATE.md
Normal file
145
AI_TASK_TEMPLATE.md
Normal file
@@ -0,0 +1,145 @@
|
||||
# AI Task Template
|
||||
|
||||
Reusable prompt template for launching tasks with AI agents.
|
||||
|
||||
This template enforces the repository workflow defined in:
|
||||
|
||||
- AGENT.md
|
||||
- AGENT_WORKFLOW.md
|
||||
- instructions-agent.md
|
||||
|
||||
It ensures every task follows the deterministic sequence:
|
||||
|
||||
PLAN → REVIEW → BUILD → VALIDATE → LOG
|
||||
|
||||
---
|
||||
|
||||
# Basic Task Structure
|
||||
|
||||
Use the following structure when requesting work from an AI agent.
|
||||
|
||||
```
|
||||
Task Type:
|
||||
PLAN | BUILD
|
||||
|
||||
Task ID:
|
||||
PLAN-YYYYMMDD-XXX | BUILD-YYYYMMDD-XXX
|
||||
|
||||
Date:
|
||||
YYYY-MM-DD HH:MM
|
||||
|
||||
Objective:
|
||||
Short description of the goal.
|
||||
|
||||
Context:
|
||||
Relevant background about the current repository state.
|
||||
|
||||
Scope:
|
||||
List of files or directories the agent may modify or inspect.
|
||||
|
||||
Requirements:
|
||||
Detailed description of the behavior that must be implemented or analyzed.
|
||||
|
||||
Constraints:
|
||||
Things the agent must NOT change or must preserve.
|
||||
|
||||
Testing:
|
||||
Describe expected tests or validations.
|
||||
|
||||
Validation:
|
||||
The agent must run:
|
||||
|
||||
make fix
|
||||
make quality
|
||||
|
||||
Logging requirements:
|
||||
- Append an entry to docs/ai-worklog.md
|
||||
- Append an entry to docs/ai-prompts.md
|
||||
- Include Date, Task ID, Agent, Scope, Result
|
||||
|
||||
Git requirements:
|
||||
- Do NOT commit or push unless explicitly requested.
|
||||
|
||||
Expected Report:
|
||||
The agent must summarize:
|
||||
- files changed
|
||||
- behavior changes
|
||||
- validation results
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Example BUILD Task
|
||||
|
||||
```
|
||||
Task Type:
|
||||
BUILD
|
||||
|
||||
Task ID:
|
||||
BUILD-YYYYMMDD-XXX
|
||||
|
||||
Date:
|
||||
YYYY-MM-DD HH:MM
|
||||
|
||||
Objective:
|
||||
Improve vertical scrolling behavior in the terminal UI.
|
||||
|
||||
Scope:
|
||||
- src/app/ui.py
|
||||
- tests/test_ui.py
|
||||
|
||||
Requirements:
|
||||
Ensure the selected entry remains visible when navigating through long directory lists.
|
||||
|
||||
Constraints:
|
||||
Do not modify navigator logic.
|
||||
|
||||
Testing:
|
||||
Add helper tests if necessary.
|
||||
|
||||
Validation:
|
||||
make fix
|
||||
make quality
|
||||
|
||||
Logging requirements:
|
||||
Update ai-worklog.md and ai-prompts.md using the standard log format.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Example PLAN Task
|
||||
|
||||
```
|
||||
Task Type:
|
||||
PLAN
|
||||
|
||||
Task ID:
|
||||
PLAN-YYYYMMDD-XXX
|
||||
|
||||
Date:
|
||||
YYYY-MM-DD HH:MM
|
||||
|
||||
Objective:
|
||||
Investigate inconsistent navigation behavior.
|
||||
|
||||
Scope:
|
||||
- src/app/ui.py
|
||||
- src/app/navigator.py
|
||||
|
||||
Requirements:
|
||||
Analyze the current navigation flow and propose a minimal fix.
|
||||
|
||||
Constraints:
|
||||
Do not modify code.
|
||||
|
||||
Expected Output:
|
||||
- diagnosis summary
|
||||
- proposed changes
|
||||
- expected file scope
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Notes
|
||||
|
||||
This template keeps AI interactions consistent across tasks and helps maintain a clean development history.
|
||||
Reference in New Issue
Block a user