AGENTS.md Configuration for Project XYZ

Project Basics

• Name: XYZ Microservice Framework
• Description: A lightweight microservice framework with RESTful API support
• Tech Stack: TypeScript, Node.js, Express, MongoDB
• Maintainers: [e-mail]
• Repository: https://gitcode.com/GitHub_Trending/ag/agents.md

3. 基础验证：使用AGENTS.md验证工具检查格式合法性
```bash
npx agents-md-validator AGENTS.md

检查要点：

• 文件必须放置于项目根目录
• 确保包含所有必填字段（项目名称、技术栈、维护者）
• 使用标准Markdown语法，避免复杂格式

第二步：开发规范体系构建

操作目标：定义AI生成代码的规范约束

实施步骤：

1. 添加代码规范模块（示例）：

   ## Code Standards
   - Naming Convention: camelCase for variables/functions, PascalCase for classes
   - File Structure: 
   

   src/ ├── api/ # API route definitions ├── models/ # Data models ├── services/ # Business logic └── utils/ # Helper functions

   - Linting Rules: Extends Airbnb JavaScript Style Guide
   - Documentation: JSDoc required for all public functions
   

2. 集成ESLint配置与AGENTS.md同步：

   # 安装AGENTS.md ESLint插件
   npm install eslint-plugin-agents-md --save-dev
   
   # 生成同步配置
   npx agents-md-sync-eslint
   

检查要点：

• 规范描述应具体明确，避免模糊表述
• 确保与项目现有ESLint/Prettier配置一致
• 包含文件组织结构图或示例

第三步：测试部署流程定义

操作目标：建立AI生成代码的质量保障体系

实施步骤：

1. 添加测试部署模块（示例）：

   ## Testing & Deployment
   - Test Requirements: 80% code coverage, unit/integration/e2e test layers
   - CI Pipeline: GitHub Actions with stages: lint → test → build → deploy
   - Environment Setup:
     ```bash
     # 开发环境配置
     npm run setup:dev
     
     # 运行测试
     npm test
     
     # 构建项目
     npm run build
   

   • Deployment Targets: Docker containers, Kubernetes cluster

2. 配置CI/CD集成：

   # 安装AGENTS.md CI集成工具
   npm install agents-md-ci --save-dev
   
   # 生成GitHub Actions配置
   npx agents-md-generate-ci