59 lines (41 loc) · 1.53 KB

Agent Project Template

This document is a template for standardizing documentation for individual agent projects. Copy this file into your agent's root directory (e.g., as README.md) and fill in the sections below.

Project Overview

[Brief description of the agent, its purpose, and key technologies.]

Agent ID: [Unique system-wide identifier for this agent]
Role: [The functional category of the agent (e.g., RiskAnalyst, DataSummarizer)]
Capabilities:
- [Capability 1]
- [Capability 2]

Setup Commands

Install dependencies: [package manager] install
Start development server: [command]
Build for production: [command]

Development Workflow

[Development server startup instructions]
[Hot reload/watch mode information]
[Environment variable setup]

Testing Instructions

Run all tests: [command]
Run unit tests: [command]
Run integration tests: [command]
Test coverage: [command]
[Specific testing patterns or requirements]

Code Style

[Language and framework conventions]
[Linting rules and commands]
[Formatting requirements]
[File organization patterns]

Build and Deployment

[Build process details]
[Output directories]
[Environment-specific builds]
[Deployment commands]

Pull Request Guidelines

Title format: [component] Brief description
Required checks: [lint command], [test command]
[Review requirements]

Additional Notes

[Any project-specific context]
[Common gotchas or troubleshooting tips]
[Performance considerations]