playbook/.agents/index.md

52 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# TSL Playbook 代理规则集(.agents/tsl
本规则集用于存放 **AI/自动化代理在仓库内工作时必须遵守的规则**
在多语言项目中,推荐将本规则集放在目标项目的 `.agents/tsl/` 下(由 `scripts/sync_standards.*` 同步),并与其他语言规则集并行:
- `.agents/tsl/`TSL 标准规则集(本仓库提供)
- `.agents/cpp/`、`.agents/python/` 等:其他语言规则集(按需新增)
这些规则与 `docs/` 下的人类开发规范并行:
- `docs/`:给人看的编码/命名/提交规范
- `.agents/`:给代理看的任务边界、质量与安全要求
## 范围与优先级
- 作为仓库级基线规则集使用;更靠近代码目录的规则应更具体并可覆盖基线。
- 当代理规则与 `docs` 发生冲突时:
1. 安全/合规优先
2. 其次保持仓库现有一致性
## 代理工作原则
- 先理解目标与上下文,再动手改代码。
- 修改要小而清晰;避免无关重构。
- 任何可能影响行为的改动都要补充或更新测试/示例(若项目有测试体系)。
- 不要引入新依赖或工具,除非明确要求。
## 子文档
- 安全与鉴权:`auth.md`
- 性能:`performance.md`
- 代码质量:`code_quality.md`
- 测试:`testing.md`
## 分类(本仓库现状)
当前本规则集下的文件全部为 **跨语言通用规则**(不绑定具体语言语法/工具链):
- `auth.md`:敏感信息/鉴权边界
- `code_quality.md`:质量底线与 review 清单
- `performance.md`:性能原则与验证
- `testing.md`:测试策略
若需要 TSL/C++ 等语言专属的代理要求,建议在目标项目新增对应目录(例如 `.agents/tsl/`、`.agents/cpp/`)或在源码子目录放置更具体的 `.agents` 覆盖规则。
## 与开发规范的关系
- 代码风格:标准快照 `docs/tsl/code_style.md`(通常位于目标项目 `docs/standards/tsl/docs/tsl/code_style.md`
- 命名规范:标准快照 `docs/tsl/naming.md`(通常位于目标项目 `docs/standards/tsl/docs/tsl/naming.md`
- 提交信息:标准快照 `docs/common/commit_message.md`(通常位于目标项目 `docs/standards/tsl/docs/common/commit_message.md`