代理配置
人工智能编码代理的个人发展标准和惯例。
目的
该存储库包含标准化的规则、约定和最佳实践,任何人工智能编码代理都可以使用这些规则、惯例和最佳实践来跨不同语言和框架生成高质量、一致的代码。
结构
.
├── AGENTS.md # Global development standards (root level)
├── CLAUDE.md # Claude Code entry point → defers to AGENTS.md
├── GEMINI.md # Gemini entry point → defers to AGENTS.md
├── .cursorrules # Cursor entry point → defers to AGENTS.md
├── .windsurfrules # Windsurf entry point → defers to AGENTS.md
├── .clinerules # Cline entry point → defers to AGENTS.md
├── .github/
│ └── copilot-instructions.md # GitHub Copilot entry point → defers to AGENTS.md
├── global-config/ # Tool configurations (symlinked to user home)
│ ├── _shared/ # Shared blocks (MCP servers, memory instructions)
│ ├── claude/ # Claude Code settings + MCP
│ ├── cursor/ # Cursor settings + keybindings + MCP + rules
│ ├── gemini/ # Gemini CLI settings + MCP
│ ├── opencode/ # OpenCode settings + MCP + instructions
│ ├── copilot/ # Copilot CLI settings + MCP
│ ├── vscode/ # VS Code settings + MCP
│ └── sync-and-deploy.ps1 # Symlink deployment script
├── knowledge/ # Standards and conventions library
│ ├── global/ # Language/framework-agnostic cross-cutting standards
│ │ ├── unit-testing.md
│ │ ├── api-design.md
│ │ └── git-workflow.md
│ ├── backend/ # Backend language-specific conventions
│ │ └── code-standards/
│ │ └── csharp/ # C# specific standards
│ │ ├── naming-conventions.md
│ │ ├── code-style.md
│ │ ├── async-programming.md
│ │ ├── class-design.md
│ │ ├── code-analysis.md
│ │ ├── error-handling.md
│ │ ├── security.md
│ │ ├── logging.md
│ │ └── dependency-injection.md
│ └── frontend/ # Frontend framework-specific conventions
│ └── (e.g. react/, angular/)
└── docs/ # AI agent long-term memory and session logs
├── issues-resolutions.md # Persistent log of issues found and resolved
└── sessions/ # Per-session summaries: YYYY-MM-DD-{agent}.md快速参考
全球标准(AGENTS.md)
- > 要求90%的测试覆盖率
- 对警告和代码气味零容忍
- 遵循固体、清洁、干燥、KISS、SRP原则
- 安全性:永不泄露秘密,验证所有输入
特定语言/框架
按以下方式组织 knowledge/backend/ (按语言)和 knowledge/frontend/ (按框架)。每个文件夹通常包含:
- 命名规范:外壳、前缀、命名规则
- 代码风格:格式、样式首选项
- 异步编程:异步/等待模式
- 课程设计:面向对象编程原则和模式
- 代码分析:起毛规则和分析器
- 错误处理:异常模式
- 安全:安全最佳做法
- 日志记录:测井标准
- 依赖注入:DI模式
AI代理内存(docs/)
- 每次工作会议后撰写的会议总结
- 发现的问题及其解决方式的持久日志
- 被视为跨会话和代理的长期记忆
用法
在任何项目上工作时,人工智能代理应该:
- 检查项目特定性
AGENTS.md在项目根中 - 阅读
docs/用于先前的背景、决策和已知问题 - 应用特定于语言/框架的约定
knowledge/backend/或knowledge/frontend/ - 从根本上遵循全球标准
AGENTS.md - 编写会话摘要
docs/sessions/会话结束时
工具配置(全局配置/)
AI工具配置集中在 global-config/ 并符号链接到用户主目录。看 global-config/README.md 有关以下内容的详细信息:
- Symlink架构
- MCP服务器配置
- 部署和同步工作流
飞行前操作
- 验证有效的OpenCode配置优先级:
- opencode debug config - opencode mcp list --print-logs --log-level DEBUG
- 验证代理/目录和内存契约的一致性:
- pwsh ./scripts/validate-agent-references.ps1
贡献
要添加新的语言/框架或更新约定:
- 在下创建或更新相关文件夹
knowledge/backend/或knowledge/frontend/ - 参考官方文档(微软、React、Angular等)
- 确保与全球一致
AGENTS.md原则 - 更新此README以反映新结构
