Files
vibe-coding-cn/libs/README.md
T

56 lines
1.9 KiB
Markdown
Raw Normal View History

2026-02-26 07:39:50 +08:00
# 📦 通用库 (libs)
2026-02-26 07:39:50 +08:00
`libs/` 只用于收纳**内部可复用的胶水代码**:小而稳、低耦合、可替换。
2026-02-26 07:39:50 +08:00
第三方工具与外部集成已迁移至:`repo/libs/external/`
`database/` 预留未来的数据持久化层(当前仅占位)。
## 目录结构
2026-02-10 17:09:33 +08:00
```text
libs/
├── README.md
├── common/
│ ├── README.md
│ ├── __init__.py
│ ├── models/
│ │ └── __init__.py
├── database/
│ ├── README.md
│ └── .gitkeep
2026-02-26 07:39:50 +08:00
└── (外部工具迁移至 repo/libs/external/)
```
## 子目录职责与边界
### `common/`:内部通用模块
- 入口:[`common/README.md`](./common/README.md)
- 只放 **可复用** 的基础能力:模型、工具函数、脚本等
- 不要把业务逻辑、项目临时代码塞进来
- 约定:新增/调整能力时,同步更新 `libs/common/README.md`
### `database/`:数据库适配层(预留)
- 入口:[`database/README.md`](./database/README.md)
- 目标是把“存储细节”关进盒子里:连接、迁移、查询适配、事务边界
- 约定:实现前先写清楚目录结构与边界(见 `libs/database/README.md`
2026-02-26 07:39:50 +08:00
### 外部工具与集成(已迁移)
2026-02-26 07:39:50 +08:00
- 外部工具/第三方项目统一收敛到:`repo/libs/external/`
- 原则:尽量保持第三方代码原样,避免“魔改后不可升级”
## 常用入口
2026-02-26 07:39:50 +08:00
- AI 聊天记录保存:`repo/libs/external/chat-vault/`(支持 Codex/Kiro/Gemini/Claude CLI
- 提示词批量管理:`repo/libs/external/prompts-library/`(配合 `prompts/` 使用)
- 备份工具:优先使用仓库根目录的 `backups/`;历史脚本在 `repo/libs/common/utils/backups/`
## 贡献约定(最小要求)
1. 新增模块先定义职责边界,再写代码/文档
2. 新增依赖记录安装方式与最低版本(必要时补充到 `documents/工具集.md`
3. 目录结构/职责变化时,更新对应 README,保证“文档即真相源”