From d64b248adfe11abb33337ac80f986f7f05ec13c9 Mon Sep 17 00:00:00 2001 From: csh Date: Sun, 17 May 2026 08:49:01 +0800 Subject: [PATCH] :memo: docs: fix README.md inaccuracies and add Claude Code info MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Fix ruleset line counts (tsl:45, cpp:46, python:44) - Add thirdparty/ to Layer 2 architecture diagram - Fix "三者" → "各规则集" (was referencing 3 but listing 5) - Add CLAUDE.md auto-creation to deployment behavior section - Add AGENTS.md and CLAUDE.md to recommended project structure Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7349e396..4f6fcb25 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,7 @@ project_name = "MyProject" - **配置节存在即启用**：只写需要同步的配置节 - **AGENTS.md**：始终按区块更新（``） +- **CLAUDE.md**：自动检测（根目录 → `.claude/`），不存在则创建；注入 `@AGENTS.md` / `@AGENT_RULES.md` - **force**：默认 false，已存在则跳过；设为 true 时强制覆盖（会先备份） 详见：`templates/README.md` @@ -117,7 +118,8 @@ Layer 1: rulesets/ (≤50 行/语言，模板源) Layer 2: codex/skills/ (按需加载，$skill-name 触发) ├─ commit-message: 提交信息规范 ├─ style-cleanup: 代码风格整理 - └─ bulk-refactor-workflow: 批量重构流程 + ├─ bulk-refactor-workflow: 批量重构流程 + └─ thirdparty/: 第三方同步 skills Layer 3: docs/ (权威静态文档) └─ 完整语法手册/代码风格/工具链配置 @@ -134,9 +136,9 @@ Layer 3: docs/ (权威静态文档) **目录结构**： - `rulesets/index.md`：规则集索引（跨语言） -- `rulesets/tsl/index.md`：TSL 核心约定（44 行） -- `rulesets/cpp/index.md`：C++ 核心约定（47 行） -- `rulesets/python/index.md`：Python 核心约定（45 行） +- `rulesets/tsl/index.md`：TSL 核心约定（45 行） +- `rulesets/cpp/index.md`：C++ 核心约定（46 行） +- `rulesets/python/index.md`：Python 核心约定（44 行） - `rulesets/typescript/index.md`：TypeScript 核心约定（47 行） - `rulesets/markdown/index.md`：Markdown 核心约定（31 行，仅代码格式化） @@ -327,7 +329,7 @@ git commit -m ":package: deps(playbook): add tsl standards" 本仓库提供多套代理规则集（同步后位于目标项目的 `.agents/tsl/` / `.agents/cpp/` / `.agents/python/` / `.agents/typescript/` / `.agents/markdown/`）： -- 三者都包含核心约定与安全红线 +- 各规则集都包含核心约定与安全红线 - 并在 `index.md` 中叠加语言级"硬约束"（TSL/TSF 语法限制、C++23/Modules、Python 风格、TypeScript 类型约束、Markdown 代码格式化等） **多语言项目推荐结构**（示例：TSL + C++ + Python + TypeScript + Markdown）： @@ -342,6 +344,8 @@ git commit -m ":package: deps(playbook): add tsl standards" │ ├── typescript/ # TypeScript/JavaScript 规则集（同上） │ └── markdown/ # Markdown 规则集（仅代码格式化） ├── .gitattributes # 行尾/文本规范 +├── AGENTS.md # Codex 入口（由 playbook 自动生成/更新） +├── CLAUDE.md # Claude Code 入口（自动注入 @AGENTS.md） ├── / # 本 Playbook 在项目内的部署根（默认 docs/standards/playbook） │ ├── docs/ │ ├── rulesets/