📦 deps(playbook): sync playbook snapshot
This commit is contained in:
@@ -0,0 +1,47 @@
|
||||
# C++ 代理规则集
|
||||
|
||||
本规则集定义 AI/自动化代理在处理 C++ 代码时必须遵守的核心约束。
|
||||
|
||||
## 范围与优先级
|
||||
|
||||
- 作为仓库级基线规则集使用；更靠近代码目录的规则更具体并可覆盖基线。
|
||||
- 当代理规则与 docs 冲突：安全/合规优先，其次保持仓库一致性。
|
||||
|
||||
## 代理工作原则（铁律）
|
||||
|
||||
1. 先理解目标与上下文，再动手改代码
|
||||
2. 修改要小而清晰；避免无关重构
|
||||
3. 发现安全问题（内存安全/鉴权漏洞）立即标注或修复
|
||||
4. 不引入新依赖或工具，除非明确要求
|
||||
|
||||
## C++ 核心约定（不可违反）
|
||||
|
||||
- 语言标准：C++23；优先使用 Modules；避免裸指针、`new/delete`、C 风格字符串
|
||||
- 代码风格：Google C++ Style Guide；使用项目 `.clang-format`；头文件保护用 `#pragma once`
|
||||
- 命名规范：文件 `lower_with_under.cpp/.h/.cppm`；类型 `CapWords`；函数/变量 `lower_with_under`；常量 `kCapWords`；成员 `lower_with_under_`；命名空间 `lower_with_under`
|
||||
- Modules 工程：模块名点分层 `lower_snake_case`；接口文件 `.cppm`；修改 `export module` 必须更新 CMake module file-set
|
||||
- 构建与依赖：Conan 需提供 `conan-release`/`conan-debug`；`conan install` + `cmake --preset ...`；Windows 通过 Linux + Clang 交叉编译验证
|
||||
|
||||
## 安全红线（不可触碰）
|
||||
|
||||
- 不得在代码/日志/注释中写入明文密钥、密码、Token、API Key
|
||||
- 避免内存不安全操作：悬垂指针、双重释放、越界访问
|
||||
- 禁用不安全函数（`strcpy`, `sprintf`, `gets` 等）
|
||||
- 修改鉴权/权限逻辑必须说明动机与风险
|
||||
|
||||
## 权威来源
|
||||
|
||||
- 代码风格：`docs/cpp/code_style.md`
|
||||
- 命名规范：`docs/cpp/naming.md`
|
||||
- 工具链：`docs/cpp/toolchain.md`
|
||||
- 依赖管理：`docs/cpp/dependencies_conan.md`
|
||||
- clangd 配置：`docs/cpp/clangd.md`
|
||||
|
||||
## Skills（按需加载）
|
||||
|
||||
- `$commit-message`
|
||||
|
||||
## 与开发规范的关系
|
||||
|
||||
- 本仓库内：`docs/cpp/` 与 `docs/common/`
|
||||
- 目标项目 subtree：`docs/standards/playbook/docs/cpp/` 与 `docs/standards/playbook/docs/common/`
|
||||
@@ -0,0 +1,29 @@
|
||||
# rulesets/（规则集模板库）
|
||||
|
||||
> **重要**：本目录位于 **playbook 仓库**，作为**规则集模板源**。
|
||||
>
|
||||
> - **模板源**：`playbook/rulesets/` → 通过 `scripts/playbook.py` 的 `[sync_standards]` 同步 → 目标项目的 `.agents/`
|
||||
> - **AI 读取**：目标项目根目录的 `.agents/`，而非此处
|
||||
> - **使用流程**：
|
||||
>
|
||||
> ```
|
||||
> playbook/rulesets/tsl/ → [sync] → your-project/.agents/tsl/ ← AI 代理读取
|
||||
> (模板源) (实际使用)
|
||||
> ```
|
||||
|
||||
本目录用于存放 **AI/自动化代理规则集模板**，用于分发到其他项目。
|
||||
|
||||
本仓库将规则按语言拆分为多个规则集模板：
|
||||
|
||||
- `rulesets/tsl/`：TSL 相关规则集（适用于 `.tsl`/`.tsf`）
|
||||
- `rulesets/cpp/`：C++ 相关规则集（C++23，含 Modules）
|
||||
- `rulesets/python/`：Python 相关规则集
|
||||
- `rulesets/markdown/`：Markdown 相关规则集（仅代码格式化）
|
||||
|
||||
目标项目落地时，通过 `scripts/playbook.py` 的 `[sync_standards]`
|
||||
将规则集从 `rulesets/<lang>/` 同步到目标项目根目录的 `.agents/<lang>/`。
|
||||
|
||||
## 三层架构（分层知识库）
|
||||
|
||||
`rulesets/` 是三层架构中的 **Layer 1**（语言级硬规则，≤50 行/语言）。
|
||||
完整分层说明见 `README.md` 的“rulesets/（规则集模板库 - 三层架构）”。
|
||||
@@ -0,0 +1,31 @@
|
||||
# Markdown 代理规则集
|
||||
|
||||
本规则集定义 AI/自动化代理在处理 Markdown（`.md`）文件时必须遵守的核心约束。
|
||||
|
||||
## 代理工作原则（铁律）
|
||||
|
||||
1. 只调整代码块与行内代码；不改写正文内容
|
||||
2. 不改变标题层级、列表结构、段落顺序
|
||||
3. 不引入新工具/格式化链路，除非明确要求
|
||||
|
||||
## Markdown 代码格式约定（不可违反）
|
||||
|
||||
### 代码块
|
||||
|
||||
- 统一使用围栏代码块（```lang）
|
||||
- 语言标识尽量准确：`tsl`/`cpp`/`python`/`bash`/`json` 等
|
||||
- 仅做必要的排版修复；不改变代码语义
|
||||
|
||||
### 工具
|
||||
|
||||
- 优先使用 Prettier（仓库已固定配置/脚本）
|
||||
- 不引入新的 Markdown 格式化依赖
|
||||
|
||||
### 行内代码
|
||||
|
||||
- 用反引号包裹命令、路径、关键字或短代码
|
||||
|
||||
## 适用范围
|
||||
|
||||
- 仅适用于 `.md` 文件
|
||||
- 涉及代码内容时，遵循对应语言的 `.agents` 规则
|
||||
@@ -0,0 +1,45 @@
|
||||
# Python 代理规则集
|
||||
|
||||
本规则集定义 AI/自动化代理在处理 Python 代码时必须遵守的核心约束。
|
||||
|
||||
## 范围与优先级
|
||||
|
||||
- 作为仓库级基线规则集使用；更靠近代码目录的规则更具体并可覆盖基线。
|
||||
- 当代理规则与 docs 冲突：安全/合规优先，其次保持仓库一致性。
|
||||
|
||||
## 代理工作原则（铁律）
|
||||
|
||||
1. 先理解目标与上下文，再动手改代码
|
||||
2. 修改要小而清晰；避免无关重构
|
||||
3. 发现安全问题（明文密钥/鉴权漏洞）立即标注或修复
|
||||
4. 不引入新依赖或工具，除非明确要求
|
||||
|
||||
## Python 核心约定（不可违反）
|
||||
|
||||
- 代码风格：Google Python Style Guide；优先使用仓库既有配置（`pyproject.toml`, `.flake8`, `.pylintrc`）
|
||||
- 工具链：未经沟通不切换 formatter/linter
|
||||
- Import：标准库 → 第三方 → 本地模块；分组间空行；避免 `import *`
|
||||
- 命名：模块/包 `lower_with_under.py`；类 `CapWords`；函数/变量 `lower_with_under`；常量 `UPPER_WITH_UNDER`；私有 `_private`
|
||||
- Docstring：Google 风格；公共模块/类/函数/方法必须写
|
||||
|
||||
## 安全红线（不可触碰）
|
||||
|
||||
- 不得在代码/日志/注释中写入明文密钥、密码、Token、API Key
|
||||
- 不得使用 `eval()` / `exec()` 处理不可信输入
|
||||
- 修改鉴权/权限逻辑必须说明动机与风险
|
||||
- 不确定是否敏感时按敏感信息处理
|
||||
|
||||
## 权威来源
|
||||
|
||||
- 代码风格：`docs/python/style_guide.md`
|
||||
- 工具链：`docs/python/tooling.md`
|
||||
- 配置清单：`docs/python/configuration.md`
|
||||
|
||||
## Skills（按需加载）
|
||||
|
||||
- `$commit-message`
|
||||
|
||||
## 与开发规范的关系
|
||||
|
||||
- 本仓库内：`docs/python/` 与 `docs/common/`
|
||||
- 目标项目 subtree：`docs/standards/playbook/docs/python/` 与 `docs/standards/playbook/docs/common/`
|
||||
@@ -0,0 +1,44 @@
|
||||
# TSL 代理规则集
|
||||
|
||||
本规则集定义 AI/自动化代理在处理 TSL 代码时必须遵守的核心约束。
|
||||
|
||||
## 范围与优先级
|
||||
|
||||
- 作为仓库级基线规则集使用；更靠近代码目录的规则更具体并可覆盖基线。
|
||||
- 当代理规则与 docs 冲突：安全/合规优先，其次保持仓库一致性。
|
||||
|
||||
## 代理工作原则（铁律）
|
||||
|
||||
1. 先理解目标与上下文，再动手改代码
|
||||
2. 修改要小而清晰；避免无关重构
|
||||
3. 发现安全问题（明文密钥/鉴权漏洞）立即标注或修复
|
||||
4. 不引入新依赖或工具，除非明确要求
|
||||
|
||||
## TSL 核心约定（不可违反）
|
||||
|
||||
- 文件结构：一文件一顶层声明；文件名 = 声明名；`.tsl` 仅 `function`，`.tsf` 可 `function/class/unit`
|
||||
- 格式：4 空格缩进；关键字小写；多语句用 `begin/end`
|
||||
- 命名：类型/函数/property `PascalCase`；变量/参数 `snake_case`；私有 `snake_case_`；常量 `kPascalCase`
|
||||
|
||||
## 安全红线（不可触碰）
|
||||
|
||||
- 不得在代码/日志/注释中写入明文密钥、密码、Token、API Key
|
||||
- 修改鉴权/权限逻辑必须说明动机与风险
|
||||
- 不确定是否敏感时按敏感信息处理
|
||||
|
||||
## 权威来源
|
||||
|
||||
- 语法手册：`docs/tsl/syntax_book/index.md`
|
||||
- 函数库：`docs/tsl/syntax_book/function/`（按需检索，禁止整份加载）
|
||||
- 代码风格：`docs/tsl/code_style.md`
|
||||
- 命名规范：`docs/tsl/naming.md`
|
||||
|
||||
## Skills（按需加载）
|
||||
|
||||
- `$tsl-guide`
|
||||
- `$commit-message`
|
||||
|
||||
## 与开发规范的关系
|
||||
|
||||
- 本仓库内：`docs/tsl/` 与 `docs/common/`
|
||||
- 目标项目 subtree：`docs/standards/playbook/docs/tsl/` 与 `docs/standards/playbook/docs/common/`
|
||||
Reference in New Issue
Block a user