45 lines
2.6 KiB
Markdown
45 lines
2.6 KiB
Markdown
# xpcool.com 工作空间 · 统一规则与项目索引
|
||
|
||
> 本文件随会话自动加载。保持精简：只放规则与索引，详细历史在各项目 CHANGELOG。
|
||
|
||
## 三条铁律（全项目通用）
|
||
1. 中文注释：写/改代码时，在应有处（函数、复杂逻辑、配置项、非显然分支）加中文注释。
|
||
2. 做记录：每次请求/变更/修复/文档动作，都在对应项目 CHANGELOG.md 顶部追加一条。
|
||
3. 中文优先：与用户的思考、输出、交流，能中文尽量中文。
|
||
|
||
## 工作空间说明（git 管理 · 跨设备同步）
|
||
- 本工作空间仓库：`workbuddy.xpcool.com`（含本规则、每日日志、README），远程：`https://git.xpcool.com/xpcool/workbuddy.xpcool.com.git`
|
||
- **布局约定（跨设备必须一致）**：所有项目与工作空间仓库位于同一父目录下：
|
||
```
|
||
<父目录>/
|
||
├── workbuddy.xpcool.com/ ← 本工作空间（规则+索引+日志）
|
||
├── admin.xpcool.com/
|
||
├── service.xpcool.com/
|
||
└── tool.xpcool.com/
|
||
```
|
||
换设备时按此布局 clone，索引即全部生效，无需改任何路径。
|
||
|
||
## 项目索引（变更记录在各项目 .workbuddy/memory/CHANGELOG.md）
|
||
| 项目 | 类型 | 相对路径（相对本工作空间） | 远程仓库 |
|
||
|------|------|--------------------------|---------|
|
||
| admin.xpcool.com | Vue 管理后台前端 | ../admin.xpcool.com/.workbuddy/memory/CHANGELOG.md | https://git.xpcool.com/xpcool/admin.xpcool.com.git |
|
||
| service.xpcool.com | Go 后端服务 | ../service.xpcool.com/.workbuddy/memory/CHANGELOG.md | https://git.xpcool.com/xpcool/service.xpcool.com.git |
|
||
| tool.xpcool.com | 前端工具站 | ../tool.xpcool.com/.workbuddy/memory/CHANGELOG.md | https://git.xpcool.com/xpcool/tool.xpcool.com.git |
|
||
（新增项目：在此加一行 + 在其 .workbuddy/memory/ 建 CHANGELOG.md + git.xpcool.com 建仓库）
|
||
|
||
## 记录格式（省 token · 快速命中）
|
||
- 倒序：最新在上，一行一条
|
||
- 模板：`YYYY-MM-DD | 类型 | 一句话摘要`
|
||
- 类型：REQ 请求 / CHG 变更 / FIX 修复 / DOC 文档 / CFG 配置 / DEP 依赖
|
||
- 示例：`2026-08-26 | CHG | 新增用户列表分页接口并补中文注释`
|
||
|
||
## 命中流程
|
||
1. 判断是否涉及某项目（看项目名/路径）。
|
||
2. 读该项目 CHANGELOG.md 头部（最新 10–15 条）了解近况。
|
||
3. 处理后于 CHANGELOG 顶部追加本次记录。
|
||
4. 新增项目时同步更新上方索引表。
|
||
|
||
## 日常同步习惯（建议）
|
||
- 每次工作结束：在各改动项目 `git add + commit + push`，本工作空间同样提交（规则/日志变化时）。
|
||
- 换设备开工前：先 `git pull` 各仓库，保证规则与记录最新。
|