Files
lpt-meta/AGENTS.md
T

86 lines
4.6 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.
# LPT Workspace Meta-Repo
本仓库不是产品项目,不包含前后端业务代码。它只作为本地工作区协调仓库,用于让 agent 一次性了解多个独立项目,并在缺失子项目时自动拉取。
## 规则与技能位置
- **通用规则(跨仓库)**:`.agents/roles/`
- `todo-discipline.md` 待办收口 · `parallel-and-delegation.md` 并行与委派 · `commit-convention.md` 提交规范
- `research-and-reporting.md` 调研与问题定位 · `shell-environment.md` Windows/PowerShell · `workspace-layout.md` 资产归属 · `repo-operations.md` 跨仓库 Git 操作
- `dev-unblock-and-escalation.md` 开发环境自解锁与求助阈值
- **各子项目专属规则**:该仓库自己的 `roles/`(如 `lpt-be/roles/`、`lpt-fe/roles/`)
- **工作区级技能**:`.agents/skills/<技能名>/`
- **子项目专属技能**:该仓库自己的 `skills/`(如 `lpt-be/skills/`)
> 规则文件开头必须是三段:名称(一级标题)→ 功能简述 → 关键字/情况(何时用,要简短,正文放后面)。
> 规则与技能的存放边界见 `.agents/roles/workspace-layout.md`。
## 本仓库
| 项目 | SSH 地址 | 默认拉取分支 |
|------|----------|--------------|
| LPT meta | `ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-meta.git` | `main` |
> 「默认拉取分支」只用于首次初始化:新人或 LLM 按这一列拉取仓库。它不表示当前的工作分支,实际在哪个分支上开发由维护者决定,不要据此推断。
## 仓库结构
| 目录 | 用途 |
|------|------|
| `lpt-be` | Java Spring Boot 后端,提供 REST API、认证、数据库访问 |
| `lpt-fe` | Vue 3 + TypeScript 前端 |
| `lpt-ai` | TypeScript + Fastify 独立 AI 服务 |
| `lpt-infra` | Kubernetes / Traefik 部署与基础设施清单 |
| `lpt-docs` | 概念与设计文档项目,只维护系统概念和设计思路 |
> 图表评审产物在 `docs/diagrams/`。
## 子项目 Git 仓库
| 目录 | SSH 地址 | 默认拉取分支 |
|------|----------|--------------|
| `lpt-be` | `ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-be.git` | `master` |
| `lpt-fe` | `ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-fe.git` | `master` |
| `lpt-ai` | `ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-ai.git` | `master` |
| `lpt-infra` | `ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-infra.git` | `master` |
| `lpt-docs` | `ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-docs.git` | `main` |
> 「默认拉取分支」只用于首次克隆初始化,下面 `git clone -b` 用的就是这一列。clone 完成后不要假定工作分支:动手前先 `git branch --show-current` 看仓库实际所在分支。
>
> **分支 ↔ 环境对应**:`lpt-be` / `lpt-fe` / `lpt-ai` 均为「`master` → prod、`dev` → dev」,部署流水线第一步会校验两者匹配,跨环境出包(例如用 `dev` 发 prod)会被直接拒绝;`lpt-ai` 的 `main` 是历史分支(停在 prod 冻结点),不再用于发版。`lpt-infra` 单分支(`master`),靠 `dev/` 与 `prod/` 目录区分清单。`lpt-docs` 不参与部署。
## 首次初始化
首次 clone 本仓库:
```bash
git clone -b main ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-meta.git lpt-meta
```
只拉取本 meta 仓库时,下列子项目目录不会包含在 Git 内容中。agent 在开始任务前应检查目录是否存在;如果缺失,直接自动 clone,无需用户手动操作:
```bash
git clone -b master ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-be.git lpt-be
git clone -b master ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-fe.git lpt-fe
git clone -b master ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-ai.git lpt-ai
git clone -b master ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-infra.git lpt-infra
git clone -b main ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-docs.git lpt-docs
```
clone 完成后,进入或修改某个子项目前,先读取该子项目根目录的 `AGENTS.md`;如果缺失,则读取 `README.md`。
## 跨项目调用关系
```text
浏览器 → lpt-fe (5158) ──/api──→ lpt-be (5157) ──HTTP──→ lpt-ai (5199)
│
└── MySQL
```
lpt-infra 提供 dev/prod 的 Kubernetes 清单和 Traefik 路由。
## 图表
- 工作区级技能 `mermaid-diagram`:按业务主题在 `docs/diagrams/<主题>/` 出图并本地起服务评审。用法见 `.agents/skills/mermaid-diagram/SKILL.md`。
- 图表根目录为 `docs/diagrams/`,共享渲染器 `docs/diagrams/viewer.js`,主题索引 `docs/diagrams/index.html`。