playbook/.agents/index.md

1.1 KiB

.agents 指南索引

本目录用于存放 AI/自动化代理在本仓库内工作时必须遵守的规则
这些规则与 docs/ 下的人类开发规范并行:

  • docs/:给人看的编码/命名/提交规范
  • .agents/:给代理看的任务边界、质量与安全要求

范围

  • 适用于本仓库所有目录与文件,除非子目录另有更具体的 .agents/*.md 覆盖说明。
  • .agentsdocs 发生冲突时:
    1. 安全/合规优先
    2. 其次保持仓库现有一致性

代理工作原则

  • 先理解目标与上下文,再动手改代码。
  • 修改要小而清晰;避免无关重构。
  • 任何可能影响行为的改动都要补充或更新测试/示例(若项目有测试体系)。
  • 不要引入新依赖或工具,除非明确要求。

子文档

  • 安全与鉴权:auth.md
  • 性能:performance.md
  • 代码质量:code_quality.md
  • 测试:testing.md

与开发规范的关系

  • 代码风格:docs/code_style.md
  • 命名规范:docs/naming.md
  • 提交信息:docs/commit_message.md