Project Name - Agents.md Example

Project Title

Project Overview

Briefly describe the purpose, functionality, and applicable scenarios of this project. Explain why this project is needed and what problems it solves.

Tech Stack

List the main technologies and tools used in the project:

• Frontend:
• Backend:
• Database:
• Deployment:
• Other Tools:

Project Structure

Describe the recommended project directory structure:

project-name/
├── src/
│   ├── components/
│   ├── pages/
│   ├── utils/
│   └── ...
├── public/
├── tests/
├── docs/
├── package.json
└── README.md

Development Guidelines

Code Style

• Use consistent code formatting tools
• Follow language-specific best practices
• Keep code clean and readable

Naming Conventions

• File naming:
• Variable naming:
• Function naming:
• Class naming:

Git Workflow

• Branch naming conventions
• Commit message format
• Pull Request process

Environment Setup

Development Requirements

• Node.js version:
• Package manager:
• Other dependencies:

Installation Steps

# 1. Clone the project
git clone [repository-url]

# 2. Install dependencies
npm install

# 3. Start development server
npm run dev

Core Feature Implementation

Feature Module 1

Describe the implementation approach and key code examples for main features.

// Example code
function exampleFunction() {
  // Implementation logic
}

Feature Module 2

Describe the implementation of another important feature.

Testing Strategy

Unit Testing

• Testing framework:
• Test coverage requirements:
• Test file organization:

Integration Testing

• Test scenarios:
• Testing tools:

End-to-End Testing

• Test workflow:
• Automation tools:

Deployment Guide

Build Process

# Build command
npm run build

Deployment Steps

1. Prepare production environment
2. Configure environment variables
3. Execute deployment scripts
4. Verify deployment results

Environment Variables

# Required environment variables
API_URL=
DATABASE_URL=
SECRET_KEY=

Performance Optimization

Frontend Optimization

• Code splitting
• Lazy loading
• Caching strategies

Backend Optimization

• Database query optimization
• Caching mechanisms
• Load balancing

Security Considerations

Data Security

• Input validation
• SQL injection protection
• XSS protection

Authentication & Authorization

• User authentication flow
• Permission control
• Token management

Monitoring and Logging

Application Monitoring

• Performance metrics
• Error tracking
• User behavior analytics

Log Management

• Log levels
• Log format
• Log storage

Common Issues

Issue 1: [Specific issue description]

Solution: Detailed solution steps

Issue 2: [Specific issue description]

Solution: Detailed solution steps

Reference Resources

• [Official Documentation Link]
• [Related Tutorials]
• [Community Resources]
• [Best Practices Guide]

Changelog

v1.0.0 (YYYY-MM-DD)

• Initial release
• Implemented basic features

---

Note: Please adjust and improve the above content according to the specific project type, remove inapplicable sections, and add project-specific content.