Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/rules-consistency.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# ==========================================
# 灵枢架构 — CI 一致性守护 (GitHub Actions)
# CI 一致性守护 (GitHub Actions)
# ==========================================
# 防止 reference/rules/ 真源与基线工具产物(CLAUDE.md / AGENTS.md)发生漂移。
# 仅校验 baseline 工具,因为只有它们入库;个人偏好工具产物在 .gitignore 中。
# 通过 npx 调用全局 CLI,仓库内不携带同步引擎。

name: rules-consistency

Expand All @@ -17,7 +18,7 @@ on:

jobs:
rules-consistency:
name: 校验灵枢规则一致性(baseline 工具)
name: 校验规则一致性(baseline 工具)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down
111 changes: 43 additions & 68 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,104 +2,79 @@
<!-- Source: reference/rules/ → generated by `lingshu sync` -->
<!-- 修改请编辑 reference/rules/ 下的真源文件,然后执行 `lingshu sync` -->

# 灵枢 (LingShu) — AI Agents 项目指令
# AI Agents 项目指令

> 本文件由 `lingshu sync` 自动生成。所有规则的真理来源位于 `reference/rules/`。
> 本文件由 `lingshu sync` 自动生成,真源位于 `reference/rules/`。


---

# 灵枢架构核心准则 (LingShu Core Principles)
# 架构核心准则

## 1. 架构拓扑定义 (Architecture Topology)
本仓库遵循 **LingShu** 架构,实行"逻辑中枢"与"执行肢体"的物理分离。
## 1. 拓扑定义
本仓库采用"中枢-肢体"分层结构:

- **🧠 中枢仓 (The Brain)**:
- **路径**: 当前根目录 `./`
- **职责**: 定义真理 (Reference)、规则 (Rules)、计划 (Plans) 与审计 (Audit)
- **特征**: 仅追踪文档与配置,不应包含业务源代码
- **中枢仓 (The Brain)**
- **路径**当前根目录 `./`
- **职责**:定义真源(Reference、规则Rules)与架构决策(Decisions)
- **特征**仅追踪文档与配置,不包含业务源代码

- **💪 肢体仓 (The Limbs)**:
- **路径**: 根目录下的具体工程子目录(通常命名为 `*-server`, `*-ui`, `*-mobile`, `*-web`)。
- **职责**: 承载具体的业务代码实现。
- **识别规则**: AI 需自动扫描根目录,识别包含 `.git` (子模块/嵌套仓) 或具体语言配置(如 `pyproject.toml`, `package.json`)的子文件夹作为"肢体"。
- **肢体仓 (The Limbs)**
- **路径**根目录下的具体工程子目录(通常命名为 `*-server``*-ui``*-mobile``*-web`)。
- **职责**承载具体的业务代码实现。
- **识别规则**AI 需自动扫描根目录,识别包含 `.git`子模块 / 嵌套仓)或具体语言配置(如 `pyproject.toml``package.json`)的子文件夹作为"肢体"。

## 2. Git 物理隔离规则 (Git Isolation Rules)
## 2. Git 物理隔离规则
由于采用嵌套仓库结构,必须严格遵守以下操作边界:

- **🚫 禁止根目录通配提交**:
- **严禁** 在根目录执行 `git add .` 或 `git commit -a`这会导致肢体仓的代码被错误地纳入中枢仓版本控制。
- 根目录 Git **仅允许** 追踪:`reference/`, AI 工具基线产物(`CLAUDE.md`, `AGENTS.md`),以及 `reference/management/` 下的任务文档
- **禁止根目录通配提交**
- **严禁**在根目录执行 `git add .` 或 `git commit -a`——这会导致肢体仓的代码被错误地纳入中枢仓版本控制。
- 根目录 Git **仅允许**追踪:`reference/` 治理资产(真源规则、docs、可选 decisions/),以及 AI 工具基线产物(`CLAUDE.md``AGENTS.md`)。

- **肢体仓独立提交**:
- **肢体仓独立提交**
- 修改具体业务代码后,必须显式 `cd [limb-folder_name]/` 进入子目录。
- 确认 `git status` 显示的是子仓库的状态后,再执行提交。

- **🛡️ 提交前自检 (Pre-commit Check)**:
- **提交前自检**:
- AI 在生成 Git 指令前,必须判断当前变更的文件路径。
- 若路径属于 `*-server/` 或 `*-ui/`,必须输出 `cd` 指令作为前置操作。

## 3. 规则真源约束 (SSoT for Rules)
## 3. 规则真源约束SSoT

- **真源唯一**: 所有 AI 行为规则的真源位于 `reference/rules/`。
- **产物只读**: `.cursor/rules/`、`.trae/rules/`、`.qoder/rules/`、`.agent/rules/`、`CLAUDE.md`、`AGENTS.md` 均为 **由 `lingshu sync` 自动生成的产物**,禁止手动编辑。
- **变更流程**: 规则修改必须改动 `reference/rules/` 真源,再执行 `lingshu sync` 重新分发。
- **CI 保障**: GitHub Actions 会校验入库产物与真源的一致性,防止漂移。

## 4. 环境与依赖标准 (Stack Standard)
*(注:此部分定义模版默认技术栈,可随项目调整)*
- **Python 环境**: 推荐使用 `uv` 或 `pip` 管理依赖。
- Windows 特殊指令: `uv` 相关命令须带 `--link-mode copy --no-install-project`。
- **Node 环境**: 推荐使用 `npm` 管理依赖与脚本(团队统一标准)。
- **交互语言**: 始终使用 **简体中文**。
- **真源唯一**:所有 AI 行为规则的真源位于 `reference/rules/`。
- **产物只读**:`.cursor/rules/`、`.trae/rules/`、`.qoder/rules/`、`.agent/rules/`、`CLAUDE.md`、`AGENTS.md` 均为**由 `lingshu sync` 自动生成的产物**,禁止手动编辑。
- **变更流程**:规则修改必须改动 `reference/rules/` 真源,再执行 `lingshu sync` 重新分发。
- **CI 保障**:GitHub Actions 会校验入库产物与真源的一致性,防止漂移。

---


---

# 🤖 灵枢智能体行为准则 (Agentic Workflow)

## 1. 思考模式:真理驱动 (Truth Driven)
在 **Ask 模式** 或 **Composer 模式** 中,遵循以下逻辑链:

1. **🔍 寻源 (Locate Truth)**:
- 遇到需求变更,**首先** 检查 `reference/docs/` 下的 API 契约、数据库 Schema 或 PRD。
- 若文档未定义,先建议用户更新文档,而不是直接写代码。
- **口号**: "逻辑不入中枢,代码不动分毫。"

2. **📝 规划 (Planning)**:
- 进入 Composer (Plan) 模式后,必须生成/更新 `.plan.md`。
- **强制存档 (CRITICAL)**: 在执行代码修改前,必须将当前的 `.plan.md` 完整复制备份到 `reference/management/plans/` 目录下,并更新 `reference/management/tasks/` 中的执行清单。文件名格式建议:`YYYYMMDD-TaskName.md`。

3. **⚡ 执行 (Execution)**:
- **跨端同步**: 始终检查后端变更对前端的影响(如 API 字段变动),并主动提示同步修改。
- **原子化**: 每次只处理一个具体的逻辑闭环,避免跨多个不相关的功能模块修改。
# AI 智能体行为准则

## 2. 自动化归档守卫 (Archival Guard)
每当一个任务进入 **Done** 状态,AI 必须强制执行以下同步操作:
## 1. 工作模式:真理驱动(软建议)

1. **方案固化**: 将最终修订的 `.plan.md` 完整备份至 `reference/management/plans/`。
2. **存证生成**: 生成一份详尽的 `Walkthrough`,记录本次重构的逻辑决策、核心代码变更及验证结果,存放至 `reference/management/walkthroughs/`。
3. **任务闭环**: 更新 `reference/management/tasks/` 中的执行记录,标注所有步骤已完成。
4. **专项审计 (Conditional)**:
- 若本次任务涉及 **数据库变更** (Schema/Migration),必须在 `reference/management/reports/` 中生成一份 `Migration_Report`。
- 文件命名标准: `YYYYMMDD_ID_TaskName.[plan|tasks|walkthrough|report].md`
- **寻源优先**:遇到需求变更,先看 `reference/docs/` 下的 API 契约、Schema、PRD;
文档未定义时,建议先更新文档再动代码。
- **跨端同步**:后端契约变动时主动提示前端影响。
- **原子化**:一次专注一个逻辑闭环,避免跨模块混合变更。

## 3. 交付规约 (Delivery Protocol)
## 2. 归档(可选,仅架构决策)

- **交互语言**: 始终使用 **简体中文** 进行对话回复。
- **Git 提交信息格式**:
- **语言**: 必须使用 **简体中文** 描述变更。
- **中枢仓**: `docs: <描述>`, `chore: <描述>`, `plan: <描述>`
- *示例*: `docs: 更新发票 API 契约`
- **肢体仓**: `<type>(<scope>): <描述>`
- *示例*: `feat(storage): 实现文件生命周期管理`
- **值得留档的场景**:架构决策、数据库迁移、破坏性 API 变更、跨仓协议变更、
事故复盘的决策链条。
- **载体**:`reference/decisions/`(ADR 格式,命名 `ADR-NNNN-<slug>.md`)。
- **日常任务不归档**——决策链条走 Git commit message + PR 描述即可。
- **判断权**:由 AI 或用户显式判定是否值得写 ADR,不再强制。

- **分支管理**:
- 开发工作必须在 `feat/*` 或 `refactor/*` 分支进行,严禁直推 `master/main`。
## 3. 交付规约

- **自我修正 (Self-Correction)**:
- 如果用户指出代码与文档不符,**必须** 优先以文档(中枢真理)为准进行修正,或者询问用户是否需要反向更新文档。
- **交互语言**:始终使用简体中文。
- **Git 提交信息**(中文描述):
- 中枢仓:`docs: <描述>` / `chore: <描述>`
- 肢体仓:`<type>(<scope>): <描述>`(例:`feat(storage): 实现文件生命周期管理`)
- **分支管理**:开发在 `feat/*` 或 `refactor/*` 分支进行,严禁直推 `master/main`。
- **自我修正**:代码与文档不符时优先以文档为准,或询问用户是否反向更新文档。

---
111 changes: 43 additions & 68 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,104 +2,79 @@
<!-- Source: reference/rules/ → generated by `lingshu sync` -->
<!-- 修改请编辑 reference/rules/ 下的真源文件,然后执行 `lingshu sync` -->

# 灵枢 (LingShu) — Claude Code 项目指令
# Claude Code 项目指令

> 本文件由 `lingshu sync` 自动生成。所有规则的真理来源位于 `reference/rules/`。
> 本文件由 `lingshu sync` 自动生成,真源位于 `reference/rules/`。


---

# 灵枢架构核心准则 (LingShu Core Principles)
# 架构核心准则

## 1. 架构拓扑定义 (Architecture Topology)
本仓库遵循 **LingShu** 架构,实行"逻辑中枢"与"执行肢体"的物理分离。
## 1. 拓扑定义
本仓库采用"中枢-肢体"分层结构:

- **🧠 中枢仓 (The Brain)**:
- **路径**: 当前根目录 `./`
- **职责**: 定义真理 (Reference)、规则 (Rules)、计划 (Plans) 与审计 (Audit)
- **特征**: 仅追踪文档与配置,不应包含业务源代码
- **中枢仓 (The Brain)**
- **路径**当前根目录 `./`
- **职责**:定义真源(Reference、规则Rules)与架构决策(Decisions)
- **特征**仅追踪文档与配置,不包含业务源代码

- **💪 肢体仓 (The Limbs)**:
- **路径**: 根目录下的具体工程子目录(通常命名为 `*-server`, `*-ui`, `*-mobile`, `*-web`)。
- **职责**: 承载具体的业务代码实现。
- **识别规则**: AI 需自动扫描根目录,识别包含 `.git` (子模块/嵌套仓) 或具体语言配置(如 `pyproject.toml`, `package.json`)的子文件夹作为"肢体"。
- **肢体仓 (The Limbs)**
- **路径**根目录下的具体工程子目录(通常命名为 `*-server``*-ui``*-mobile``*-web`)。
- **职责**承载具体的业务代码实现。
- **识别规则**AI 需自动扫描根目录,识别包含 `.git`子模块 / 嵌套仓)或具体语言配置(如 `pyproject.toml``package.json`)的子文件夹作为"肢体"。

## 2. Git 物理隔离规则 (Git Isolation Rules)
## 2. Git 物理隔离规则
由于采用嵌套仓库结构,必须严格遵守以下操作边界:

- **🚫 禁止根目录通配提交**:
- **严禁** 在根目录执行 `git add .` 或 `git commit -a`这会导致肢体仓的代码被错误地纳入中枢仓版本控制。
- 根目录 Git **仅允许** 追踪:`reference/`, AI 工具基线产物(`CLAUDE.md`, `AGENTS.md`),以及 `reference/management/` 下的任务文档
- **禁止根目录通配提交**
- **严禁**在根目录执行 `git add .` 或 `git commit -a`——这会导致肢体仓的代码被错误地纳入中枢仓版本控制。
- 根目录 Git **仅允许**追踪:`reference/` 治理资产(真源规则、docs、可选 decisions/),以及 AI 工具基线产物(`CLAUDE.md``AGENTS.md`)。

- **肢体仓独立提交**:
- **肢体仓独立提交**
- 修改具体业务代码后,必须显式 `cd [limb-folder_name]/` 进入子目录。
- 确认 `git status` 显示的是子仓库的状态后,再执行提交。

- **🛡️ 提交前自检 (Pre-commit Check)**:
- **提交前自检**:
- AI 在生成 Git 指令前,必须判断当前变更的文件路径。
- 若路径属于 `*-server/` 或 `*-ui/`,必须输出 `cd` 指令作为前置操作。

## 3. 规则真源约束 (SSoT for Rules)
## 3. 规则真源约束SSoT

- **真源唯一**: 所有 AI 行为规则的真源位于 `reference/rules/`。
- **产物只读**: `.cursor/rules/`、`.trae/rules/`、`.qoder/rules/`、`.agent/rules/`、`CLAUDE.md`、`AGENTS.md` 均为 **由 `lingshu sync` 自动生成的产物**,禁止手动编辑。
- **变更流程**: 规则修改必须改动 `reference/rules/` 真源,再执行 `lingshu sync` 重新分发。
- **CI 保障**: GitHub Actions 会校验入库产物与真源的一致性,防止漂移。

## 4. 环境与依赖标准 (Stack Standard)
*(注:此部分定义模版默认技术栈,可随项目调整)*
- **Python 环境**: 推荐使用 `uv` 或 `pip` 管理依赖。
- Windows 特殊指令: `uv` 相关命令须带 `--link-mode copy --no-install-project`。
- **Node 环境**: 推荐使用 `npm` 管理依赖与脚本(团队统一标准)。
- **交互语言**: 始终使用 **简体中文**。
- **真源唯一**:所有 AI 行为规则的真源位于 `reference/rules/`。
- **产物只读**:`.cursor/rules/`、`.trae/rules/`、`.qoder/rules/`、`.agent/rules/`、`CLAUDE.md`、`AGENTS.md` 均为**由 `lingshu sync` 自动生成的产物**,禁止手动编辑。
- **变更流程**:规则修改必须改动 `reference/rules/` 真源,再执行 `lingshu sync` 重新分发。
- **CI 保障**:GitHub Actions 会校验入库产物与真源的一致性,防止漂移。

---


---

# 🤖 灵枢智能体行为准则 (Agentic Workflow)

## 1. 思考模式:真理驱动 (Truth Driven)
在 **Ask 模式** 或 **Composer 模式** 中,遵循以下逻辑链:

1. **🔍 寻源 (Locate Truth)**:
- 遇到需求变更,**首先** 检查 `reference/docs/` 下的 API 契约、数据库 Schema 或 PRD。
- 若文档未定义,先建议用户更新文档,而不是直接写代码。
- **口号**: "逻辑不入中枢,代码不动分毫。"

2. **📝 规划 (Planning)**:
- 进入 Composer (Plan) 模式后,必须生成/更新 `.plan.md`。
- **强制存档 (CRITICAL)**: 在执行代码修改前,必须将当前的 `.plan.md` 完整复制备份到 `reference/management/plans/` 目录下,并更新 `reference/management/tasks/` 中的执行清单。文件名格式建议:`YYYYMMDD-TaskName.md`。

3. **⚡ 执行 (Execution)**:
- **跨端同步**: 始终检查后端变更对前端的影响(如 API 字段变动),并主动提示同步修改。
- **原子化**: 每次只处理一个具体的逻辑闭环,避免跨多个不相关的功能模块修改。
# AI 智能体行为准则

## 2. 自动化归档守卫 (Archival Guard)
每当一个任务进入 **Done** 状态,AI 必须强制执行以下同步操作:
## 1. 工作模式:真理驱动(软建议)

1. **方案固化**: 将最终修订的 `.plan.md` 完整备份至 `reference/management/plans/`。
2. **存证生成**: 生成一份详尽的 `Walkthrough`,记录本次重构的逻辑决策、核心代码变更及验证结果,存放至 `reference/management/walkthroughs/`。
3. **任务闭环**: 更新 `reference/management/tasks/` 中的执行记录,标注所有步骤已完成。
4. **专项审计 (Conditional)**:
- 若本次任务涉及 **数据库变更** (Schema/Migration),必须在 `reference/management/reports/` 中生成一份 `Migration_Report`。
- 文件命名标准: `YYYYMMDD_ID_TaskName.[plan|tasks|walkthrough|report].md`
- **寻源优先**:遇到需求变更,先看 `reference/docs/` 下的 API 契约、Schema、PRD;
文档未定义时,建议先更新文档再动代码。
- **跨端同步**:后端契约变动时主动提示前端影响。
- **原子化**:一次专注一个逻辑闭环,避免跨模块混合变更。

## 3. 交付规约 (Delivery Protocol)
## 2. 归档(可选,仅架构决策)

- **交互语言**: 始终使用 **简体中文** 进行对话回复。
- **Git 提交信息格式**:
- **语言**: 必须使用 **简体中文** 描述变更。
- **中枢仓**: `docs: <描述>`, `chore: <描述>`, `plan: <描述>`
- *示例*: `docs: 更新发票 API 契约`
- **肢体仓**: `<type>(<scope>): <描述>`
- *示例*: `feat(storage): 实现文件生命周期管理`
- **值得留档的场景**:架构决策、数据库迁移、破坏性 API 变更、跨仓协议变更、
事故复盘的决策链条。
- **载体**:`reference/decisions/`(ADR 格式,命名 `ADR-NNNN-<slug>.md`)。
- **日常任务不归档**——决策链条走 Git commit message + PR 描述即可。
- **判断权**:由 AI 或用户显式判定是否值得写 ADR,不再强制。

- **分支管理**:
- 开发工作必须在 `feat/*` 或 `refactor/*` 分支进行,严禁直推 `master/main`。
## 3. 交付规约

- **自我修正 (Self-Correction)**:
- 如果用户指出代码与文档不符,**必须** 优先以文档(中枢真理)为准进行修正,或者询问用户是否需要反向更新文档。
- **交互语言**:始终使用简体中文。
- **Git 提交信息**(中文描述):
- 中枢仓:`docs: <描述>` / `chore: <描述>`
- 肢体仓:`<type>(<scope>): <描述>`(例:`feat(storage): 实现文件生命周期管理`)
- **分支管理**:开发在 `feat/*` 或 `refactor/*` 分支进行,严禁直推 `master/main`。
- **自我修正**:代码与文档不符时优先以文档为准,或询问用户是否反向更新文档。

---
Loading
Loading