chore: repo - flatten tool mirrors
This commit is contained in:
parent
675211c864
commit
33b39f6757
|
|
@ -1,9 +1,9 @@
|
||||||
[submodule "repo/libs/external/.tmux"]
|
[submodule "repo/.tmux"]
|
||||||
path = repo/libs/external/.tmux
|
path = repo/.tmux
|
||||||
url = https://github.com/gpakosz/.tmux.git
|
url = https://github.com/gpakosz/.tmux.git
|
||||||
[submodule "repo/libs/external/tmux"]
|
[submodule "repo/tmux"]
|
||||||
path = repo/libs/external/tmux
|
path = repo/tmux
|
||||||
url = https://github.com/tmux/tmux.git
|
url = https://github.com/tmux/tmux.git
|
||||||
[submodule "repo/libs/external/claude-official-skills"]
|
[submodule "repo/claude-official-skills"]
|
||||||
path = repo/libs/external/claude-official-skills
|
path = repo/claude-official-skills
|
||||||
url = https://github.com/anthropics/skills.git
|
url = https://github.com/anthropics/skills.git
|
||||||
|
|
|
||||||
41
AGENTS.md
41
AGENTS.md
|
|
@ -8,7 +8,7 @@
|
||||||
|
|
||||||
### 允许的操作
|
### 允许的操作
|
||||||
- 读取、修改顶层文档:`README.md`、`AGENTS.md`、`CLAUDE.md`、`GEMINI.md` 等
|
- 读取、修改顶层文档:`README.md`、`AGENTS.md`、`CLAUDE.md`、`GEMINI.md` 等
|
||||||
- 读取、修改 `documents/`、`prompts/`、`skills/`、`workflow/`、`config/`、`tools/`、`libs/` 下的文档与代码
|
- 读取、修改 `documents/`、`prompts/`、`skills/`、`workflow/`、`config/`、`tools/`、`repo/` 下的文档与代码
|
||||||
- 执行 `make lint`、备份脚本、prompts-library 转换工具
|
- 执行 `make lint`、备份脚本、prompts-library 转换工具
|
||||||
- 新增/修改提示词、技能、文档
|
- 新增/修改提示词、技能、文档
|
||||||
- 提交符合规范的 commit
|
- 提交符合规范的 commit
|
||||||
|
|
@ -65,7 +65,7 @@ git push origin develop
|
||||||
| `make lint` | 校验全仓库 Markdown | 需安装 markdownlint-cli |
|
| `make lint` | 校验全仓库 Markdown | 需安装 markdownlint-cli |
|
||||||
| `bash backups/一键备份.sh` | 创建完整项目备份 | 无 |
|
| `bash backups/一键备份.sh` | 创建完整项目备份 | 无 |
|
||||||
| `python3 backups/快速备份.py` | Python 版备份脚本 | Python 3.8+ |
|
| `python3 backups/快速备份.py` | Python 版备份脚本 | Python 3.8+ |
|
||||||
| `cd repo/libs/external/prompts-library && python3 main.py` | 提示词格式转换 | pandas, openpyxl, PyYAML |
|
| `cd repo/prompts-library && python3 main.py` | 提示词格式转换 | pandas, openpyxl, PyYAML |
|
||||||
|
|
||||||
### prompts-library 支持的转换模式
|
### prompts-library 支持的转换模式
|
||||||
1. Excel → Docs:将 Excel 工作簿转换为 Markdown 文档目录
|
1. Excel → Docs:将 Excel 工作簿转换为 Markdown 文档目录
|
||||||
|
|
@ -89,12 +89,11 @@ git push origin develop
|
||||||
- `workflow/` - 可复用工作流模板(自动开发闭环等)
|
- `workflow/` - 可复用工作流模板(自动开发闭环等)
|
||||||
- `config/` - 工具与开发配置(例如 Codex CLI)
|
- `config/` - 工具与开发配置(例如 Codex CLI)
|
||||||
- `tools/` - 预留:自定义脚本/小工具(保持可替换、可审计)
|
- `tools/` - 预留:自定义脚本/小工具(保持可替换、可审计)
|
||||||
- `libs/common/` - 通用模块
|
- `repo/` - 外部工具与依赖(含 Git submodule)
|
||||||
- `repo/libs/external/` - 外部工具与依赖
|
|
||||||
|
|
||||||
### 依赖添加规则
|
### 依赖添加规则
|
||||||
- 新增工具或库时记录安装方式、最小版本与来源
|
- 新增工具或库时记录安装方式、最小版本与来源
|
||||||
- 外部依赖来源记录在 `repo/libs/external/` 目录下
|
- 外部依赖来源记录在 `repo/` 目录下
|
||||||
- 引入第三方脚本需标明许可证与来源
|
- 引入第三方脚本需标明许可证与来源
|
||||||
|
|
||||||
### 禁止行为
|
### 禁止行为
|
||||||
|
|
@ -181,18 +180,20 @@ git push origin develop
|
||||||
│ ├── auto-dev-loop/ # 自动开发循环
|
│ ├── auto-dev-loop/ # 自动开发循环
|
||||||
│ └── canvas-dev/ # Canvas白板驱动开发
|
│ └── canvas-dev/ # Canvas白板驱动开发
|
||||||
│
|
│
|
||||||
├── libs/ # 核心库代码
|
|
||||||
│ ├── common/ # 通用模块
|
|
||||||
│ │ ├── models/ # 模型定义
|
|
||||||
│ │ └── utils/ # 工具函数(预留)
|
|
||||||
│ └── database/ # 数据库模块(预留)
|
|
||||||
│
|
|
||||||
├── repo/ # 可执行代码与外部依赖镜像
|
├── repo/ # 可执行代码与外部依赖镜像
|
||||||
│ └── libs/
|
│ ├── README.md # 外部工具索引
|
||||||
│ ├── external/ # 外部工具(含 Git submodule)
|
│ ├── AGENTS.md # repo/ 目录规则
|
||||||
│ └── common/
|
│ ├── prompts-library/ # Excel ↔ Markdown 互转工具
|
||||||
│ └── utils/
|
│ ├── chat-vault/ # AI 聊天记录保存工具
|
||||||
│ └── backups/ # 历史备份脚本快照
|
│ ├── Skill_Seekers-development/ # Skills 制作器
|
||||||
|
│ ├── html-tools-main/ # HTML 工具集
|
||||||
|
│ ├── my-nvim/ # Neovim 配置
|
||||||
|
│ ├── MCPlayerTransfer/ # MC 玩家迁移工具
|
||||||
|
│ ├── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF
|
||||||
|
│ ├── backups/ # 历史备份脚本快照
|
||||||
|
│ ├── .tmux/ # oh-my-tmux (submodule)
|
||||||
|
│ ├── tmux/ # tmux 源码 (submodule)
|
||||||
|
│ └── claude-official-skills/ # Claude 官方 skills (submodule)
|
||||||
│
|
│
|
||||||
├── tools/ # 工具目录(预留)
|
├── tools/ # 工具目录(预留)
|
||||||
│ └── .gitkeep # 保持空目录被 Git 追踪
|
│ └── .gitkeep # 保持空目录被 Git 追踪
|
||||||
|
|
@ -207,7 +208,7 @@ git push origin develop
|
||||||
### 关键入口文件
|
### 关键入口文件
|
||||||
- `README.md` - 项目主文档,面向人类开发者
|
- `README.md` - 项目主文档,面向人类开发者
|
||||||
- `AGENTS.md` - AI Agent 操作手册(本文件)
|
- `AGENTS.md` - AI Agent 操作手册(本文件)
|
||||||
- `repo/libs/external/prompts-library/main.py` - 提示词转换工具入口
|
- `repo/prompts-library/main.py` - 提示词转换工具入口
|
||||||
- `backups/一键备份.sh` - 备份脚本入口
|
- `backups/一键备份.sh` - 备份脚本入口
|
||||||
- `skills/tmux-autopilot/` - tmux 自动化操控技能(基于 oh-my-tmux,含 capture-pane/send-keys/蜂群巡检脚本)
|
- `skills/tmux-autopilot/` - tmux 自动化操控技能(基于 oh-my-tmux,含 capture-pane/send-keys/蜂群巡检脚本)
|
||||||
- `skills/sop-generator/` - SOP 生成与规范化技能(输入资料/需求 -> 标准 SOP)
|
- `skills/sop-generator/` - SOP 生成与规范化技能(输入资料/需求 -> 标准 SOP)
|
||||||
|
|
@ -281,7 +282,7 @@ feat|fix|docs|chore|refactor|test: scope - summary
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 提示词库转换
|
# 提示词库转换
|
||||||
cd repo/libs/external/prompts-library && python3 main.py
|
cd repo/prompts-library && python3 main.py
|
||||||
|
|
||||||
# Lint 所有 Markdown 文件
|
# Lint 所有 Markdown 文件
|
||||||
make lint
|
make lint
|
||||||
|
|
@ -296,8 +297,8 @@ bash backups/一键备份.sh
|
||||||
- **`prompts/`**: 提示词库(指向云端表格)
|
- **`prompts/`**: 提示词库(指向云端表格)
|
||||||
- **`skills/`**: 扁平化技能库(详见 skills/README.md)
|
- **`skills/`**: 扁平化技能库(详见 skills/README.md)
|
||||||
- **`documents/`**: 知识库(05-哲学与方法论、00-基础指南、01-入门指南、02-方法论、03-实战、04-资源)
|
- **`documents/`**: 知识库(05-哲学与方法论、00-基础指南、01-入门指南、02-方法论、03-实战、04-资源)
|
||||||
- **`repo/libs/external/prompts-library/`**: Excel ↔ Markdown 转换工具
|
- **`repo/prompts-library/`**: Excel ↔ Markdown 转换工具
|
||||||
- **`repo/libs/external/chat-vault/`**: AI 聊天记录保存工具
|
- **`repo/chat-vault/`**: AI 聊天记录保存工具
|
||||||
- **`backups/`**: 备份脚本与存档
|
- **`backups/`**: 备份脚本与存档
|
||||||
|
|
||||||
### Key Technical Details
|
### Key Technical Details
|
||||||
|
|
|
||||||
35
README.md
35
README.md
|
|
@ -49,7 +49,7 @@
|
||||||
<a href="./skills/"><img src="https://img.shields.io/badge/⚡_Skills-技能大全-forestgreen?style=for-the-badge" alt="skills技能大全"></a>
|
<a href="./skills/"><img src="https://img.shields.io/badge/⚡_Skills-技能大全-forestgreen?style=for-the-badge" alt="skills技能大全"></a>
|
||||||
<a href="https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203"><img src="https://img.shields.io/badge/📋_提示词-在线表格-blue?style=for-the-badge" alt="提示词在线表格"></a>
|
<a href="https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203"><img src="https://img.shields.io/badge/📋_提示词-在线表格-blue?style=for-the-badge" alt="提示词在线表格"></a>
|
||||||
<a href="https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools"><img src="https://img.shields.io/badge/🔧_系统提示词-仓库-slateblue?style=for-the-badge" alt="系统提示词仓库"></a>
|
<a href="https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools"><img src="https://img.shields.io/badge/🔧_系统提示词-仓库-slateblue?style=for-the-badge" alt="系统提示词仓库"></a>
|
||||||
<a href="./repo/libs/external/chat-vault/README.md"><img src="https://img.shields.io/badge/🔐_Chat_Vault-AI会话库-gold?style=for-the-badge" alt="Chat Vault"></a>
|
<a href="./repo/chat-vault/README.md"><img src="https://img.shields.io/badge/🔐_Chat_Vault-AI会话库-gold?style=for-the-badge" alt="Chat Vault"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
[📋 工具与资源](#tools)
|
[📋 工具与资源](#tools)
|
||||||
|
|
@ -330,8 +330,8 @@ Canvas方式:**代码 ⇄ 白板 ⇄ AI ⇄ 人类**,白板成为单一真
|
||||||
### 项目内部文档
|
### 项目内部文档
|
||||||
|
|
||||||
* [**胶水编程 (Glue Coding)**](./documents/00-基础指南/): 软件工程的圣杯与银弹,Vibe Coding 的终极进化形态。
|
* [**胶水编程 (Glue Coding)**](./documents/00-基础指南/): 软件工程的圣杯与银弹,Vibe Coding 的终极进化形态。
|
||||||
* [**Chat Vault**](./repo/libs/external/chat-vault/): AI 聊天记录保存工具,支持 Codex/Kiro/Gemini/Claude CLI。
|
* [**Chat Vault**](./repo/chat-vault/): AI 聊天记录保存工具,支持 Codex/Kiro/Gemini/Claude CLI。
|
||||||
* [**prompts-library 工具说明**](./repo/libs/external/prompts-library/): 支持 Excel 与 Markdown 格式互转,包含数百个精选提示词。
|
* [**prompts-library 工具说明**](./repo/prompts-library/): 支持 Excel 与 Markdown 格式互转,包含数百个精选提示词。
|
||||||
* [**编程提示词集合**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): 适用于 Vibe Coding 流程的专用提示词(云端表格)。
|
* [**编程提示词集合**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): 适用于 Vibe Coding 流程的专用提示词(云端表格)。
|
||||||
* [**系统提示词构建原则**](./documents/00-基础指南/系统提示词构建原则.md): 构建高效 AI 系统提示词的综合指南。
|
* [**系统提示词构建原则**](./documents/00-基础指南/系统提示词构建原则.md): 构建高效 AI 系统提示词的综合指南。
|
||||||
* [**开发经验总结**](./documents/00-基础指南/开发经验.md): 变量命名、文件结构、编码规范、架构原则等。
|
* [**开发经验总结**](./documents/00-基础指南/开发经验.md): 变量命名、文件结构、编码规范、架构原则等。
|
||||||
|
|
@ -418,20 +418,19 @@ Canvas方式:**代码 ⇄ 白板 ⇄ AI ⇄ 人类**,白板成为单一真
|
||||||
│ ├── auto-dev-loop/ # 自动开发循环
|
│ ├── auto-dev-loop/ # 自动开发循环
|
||||||
│ └── canvas-dev/ # Canvas白板驱动开发
|
│ └── canvas-dev/ # Canvas白板驱动开发
|
||||||
│
|
│
|
||||||
├── libs/ # 核心库代码
|
├── repo/ # 外部工具与依赖镜像(含 Git submodule)
|
||||||
│ ├── common/ # 通用模块
|
│ ├── README.md # 外部工具索引
|
||||||
│ │ ├── models/ # 模型定义
|
│ ├── prompts-library/ # Excel ↔ Markdown 互转工具
|
||||||
│ │ └── utils/ # 工具函数
|
│ ├── chat-vault/ # AI 聊天记录保存工具
|
||||||
│ ├── database/ # 数据库模块(预留)
|
│ ├── Skill_Seekers-development/ # Skills 制作器
|
||||||
│ └── external/ # 外部工具
|
│ ├── html-tools-main/ # HTML 工具集
|
||||||
│ ├── prompts-library/ # Excel ↔ Markdown 互转工具
|
│ ├── my-nvim/ # Neovim 配置
|
||||||
│ ├── chat-vault/ # AI 聊天记录保存工具
|
│ ├── MCPlayerTransfer/ # MC 玩家迁移工具
|
||||||
│ ├── Skill_Seekers-development/ # Skills 制作器
|
│ ├── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF
|
||||||
│ ├── .tmux/ # oh-my-tmux (submodule)
|
│ ├── backups/ # 历史备份脚本快照
|
||||||
│ ├── tmux/ # tmux 源码 (submodule)
|
│ ├── .tmux/ # oh-my-tmux (submodule)
|
||||||
│ ├── my-nvim/ # Neovim 配置
|
│ ├── tmux/ # tmux 源码 (submodule)
|
||||||
│ ├── MCPlayerTransfer/ # MC 玩家迁移工具
|
│ └── claude-official-skills/ # Claude 官方 skills (submodule)
|
||||||
│ └── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF
|
|
||||||
│
|
│
|
||||||
├── tools/ # 工具目录(预留)
|
├── tools/ # 工具目录(预留)
|
||||||
│ └── .gitkeep # 保持空目录被 Git 追踪
|
│ └── .gitkeep # 保持空目录被 Git 追踪
|
||||||
|
|
@ -596,7 +595,7 @@ gantt
|
||||||
|
|
||||||
本指南同时适用于 CLI 终端版本和 VSCode 扩展版本(Codex 和 Claude Code 都有扩展,且界面更新)。
|
本指南同时适用于 CLI 终端版本和 VSCode 扩展版本(Codex 和 Claude Code 都有扩展,且界面更新)。
|
||||||
|
|
||||||
*(注:本指南早期版本使用的是 **Grok 3**,后来切换到 **Gemini 2.5 Pro**,现在我们使用的是 **Claude 4.6**(或 **gpt-5.3-codex (xhigh)**))*
|
*(注:本指南早期版本使用的是 **Grok 3**,后来切换到 **Gemini 3.1 Pro**,现在我们使用的是 **Claude 4.6**(或 **gpt-5.3-codex (xhigh)**))*
|
||||||
|
|
||||||
*(注2:如果你想使用 Cursor,请查看本指南的 [1.1 版本](https://github.com/EnzeD/vibe-coding/tree/1.1.1),但我们认为它目前不如 Codex CLI 或 Claude Code 强大)*
|
*(注2:如果你想使用 Cursor,请查看本指南的 [1.1 版本](https://github.com/EnzeD/vibe-coding/tree/1.1.1),但我们认为它目前不如 Codex CLI 或 Claude Code 强大)*
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,55 +0,0 @@
|
||||||
# 📦 通用库 (libs)
|
|
||||||
|
|
||||||
`libs/` 只用于收纳**内部可复用的胶水代码**:小而稳、低耦合、可替换。
|
|
||||||
|
|
||||||
第三方工具与外部集成已迁移至:`repo/libs/external/`。
|
|
||||||
|
|
||||||
`database/` 预留未来的数据持久化层(当前仅占位)。
|
|
||||||
|
|
||||||
## 目录结构
|
|
||||||
|
|
||||||
```text
|
|
||||||
libs/
|
|
||||||
├── README.md
|
|
||||||
├── common/
|
|
||||||
│ ├── README.md
|
|
||||||
│ ├── __init__.py
|
|
||||||
│ ├── models/
|
|
||||||
│ │ └── __init__.py
|
|
||||||
├── database/
|
|
||||||
│ ├── README.md
|
|
||||||
│ └── .gitkeep
|
|
||||||
└── (外部工具迁移至 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`)
|
|
||||||
|
|
||||||
### 外部工具与集成(已迁移)
|
|
||||||
|
|
||||||
- 外部工具/第三方项目统一收敛到:`repo/libs/external/`
|
|
||||||
- 原则:尽量保持第三方代码原样,避免“魔改后不可升级”
|
|
||||||
|
|
||||||
## 常用入口
|
|
||||||
|
|
||||||
- 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,保证“文档即真相源”
|
|
||||||
|
|
@ -1,40 +0,0 @@
|
||||||
# 🔧 libs/common:通用模块
|
|
||||||
|
|
||||||
`libs/common/` 放的是项目内部可复用的“胶水代码”:**小而稳、低耦合、可替换**。这里的目标不是堆功能,而是为仓库提供少量可靠的基础能力。
|
|
||||||
|
|
||||||
## 目录结构
|
|
||||||
|
|
||||||
```
|
|
||||||
libs/common/
|
|
||||||
├── README.md
|
|
||||||
├── __init__.py
|
|
||||||
├── models/ # 预留:数据模型(当前仅占位)
|
|
||||||
│ └── __init__.py
|
|
||||||
└── utils/
|
|
||||||
└── backups/ # 基于 .gitignore 的快速备份工具
|
|
||||||
├── README.md
|
|
||||||
├── 快速备份.py
|
|
||||||
└── 一键备份.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
## 现有内容
|
|
||||||
|
|
||||||
- `utils/backups/`:快速备份工具(当前与仓库根目录 [`backups/`](../../backups/) 内容一致,用于避免脚本散落各处)
|
|
||||||
|
|
||||||
## 约束与约定
|
|
||||||
|
|
||||||
1. **不放业务逻辑**:`common/` 只提供基础能力与工具
|
|
||||||
2. **接口要稳**:一旦被引用,就把它当作公开 API 对待
|
|
||||||
3. **可审计输出**:脚本/工具的输出要可复盘(明确输入、输出路径、失败原因)
|
|
||||||
4. **新增即文档**:新增模块/目录必须同步更新本 README 与 `libs/README.md`
|
|
||||||
|
|
||||||
## 使用方式(当前推荐)
|
|
||||||
|
|
||||||
本目录的内容目前主要以“脚本/工具”形式存在,推荐直接运行:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 备份当前仓库(建议优先使用根目录 backups/ 入口)
|
|
||||||
python3 backups/快速备份.py
|
|
||||||
```
|
|
||||||
|
|
||||||
更多参数与说明见:[`../../backups/README.md`](../../backups/README.md)。
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
# Common Library
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
# Models Module
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
# Third-party libraries (read-only)
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
# 🗄️ libs/database:数据库适配层(预留)
|
|
||||||
|
|
||||||
`libs/database/` 预留给未来的“存储适配层”。目标是把数据库的细节(连接、迁移、事务、查询)封装在一个清晰边界内,避免业务代码到处散落 SQL/ORM。
|
|
||||||
|
|
||||||
## 设计边界(先写清楚再实现)
|
|
||||||
|
|
||||||
- 这里负责:连接管理、迁移脚本、ORM/SQL 模型、统一的查询/事务封装
|
|
||||||
- 这里不负责:业务规则、HTTP/API 逻辑、领域对象的复杂编排
|
|
||||||
|
|
||||||
## 推荐目录结构(落地时按需取舍)
|
|
||||||
|
|
||||||
```
|
|
||||||
libs/database/
|
|
||||||
├── README.md
|
|
||||||
├── __init__.py
|
|
||||||
├── connection.py # 连接与池化
|
|
||||||
├── migrations/ # 迁移脚本(Alembic/Flyway/自研均可)
|
|
||||||
├── repositories/ # 数据访问层(可选)
|
|
||||||
└── models/ # ORM 模型或 SQL schema(可选)
|
|
||||||
```
|
|
||||||
|
|
||||||
## 何时开始实现
|
|
||||||
|
|
||||||
当仓库出现“需要长期保存/查询的数据”且 **文件系统不够用** 时,再把这一层落地;否则保持为空,避免过早引入复杂度。
|
|
||||||
|
|
@ -29,4 +29,4 @@
|
||||||
|
|
||||||
## 相关工具
|
## 相关工具
|
||||||
|
|
||||||
- `repo/libs/external/prompts-library/` - Excel ↔ Markdown 互转工具
|
- `repo/prompts-library/` - Excel ↔ Markdown 互转工具
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@
|
||||||
|
|
||||||
- [技能库](../skills/) - 比提示词更高级的能力封装
|
- [技能库](../skills/) - 比提示词更高级的能力封装
|
||||||
- [文档库](../documents/) - 方法论与开发经验
|
- [文档库](../documents/) - 方法论与开发经验
|
||||||
- [prompts-library 工具](../repo/libs/external/prompts-library/)
|
- [prompts-library 工具](../repo/prompts-library/)
|
||||||
Excel ↔ Markdown 互转工具
|
Excel ↔ Markdown 互转工具
|
||||||
|
|
||||||
## 原版表格
|
## 原版表格
|
||||||
|
|
|
||||||
|
|
@ -1,21 +1,26 @@
|
||||||
# repo/ 目录 Agent 指南
|
# repo/ 目录 Agent 指南
|
||||||
|
|
||||||
本目录用于收纳**可执行代码与外部依赖镜像**,将“知识库/提示词/技能”与“代码/第三方工具”做物理隔离,便于迁移与审计。
|
本目录用于收纳 **外部工具/第三方项目**(含 Git submodule),保持“主仓库资产”和“外部依赖”边界清晰、可审计、可更新。
|
||||||
|
|
||||||
## 目录结构(当前)
|
## 目录结构(约定)
|
||||||
|
|
||||||
```text
|
```text
|
||||||
repo/
|
repo/
|
||||||
├── AGENTS.md
|
├── AGENTS.md # 本文件(目录级行为准则)
|
||||||
└── libs/
|
├── README.md # 外部工具索引
|
||||||
├── external/ # 第三方工具与外部集成(含 Git submodule)
|
├── .tmux/ # submodule:oh-my-tmux 配置
|
||||||
└── common/
|
├── tmux/ # submodule:tmux 源码
|
||||||
└── utils/
|
└── claude-official-skills/ # submodule:Claude 官方 skills 仓库(Anthropic)
|
||||||
└── backups/ # 历史备份脚本快照(README + 脚本)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 操作规范
|
## 操作规范
|
||||||
|
|
||||||
- `repo/libs/external/`:尽量原样保留外部项目,优先使用 Git submodule 管理上游。
|
### 允许
|
||||||
- `repo/libs/common/utils/backups/`:只做“脚本快照/参考”;常用备份优先使用仓库根目录 `backups/`。
|
|
||||||
- 若需要更新路径/结构,必须同步更新:根目录 `AGENTS.md`、`README.md` 及本文件,保证“文档即真相源”。
|
- 新增外部依赖(优先 Git submodule,确保可复现)
|
||||||
|
- 更新 submodule 指针(明确记录上游来源与用途)
|
||||||
|
|
||||||
|
### 禁止 / 不推荐
|
||||||
|
|
||||||
|
- 直接复制粘贴大型第三方仓库内容到主仓库(优先 submodule)
|
||||||
|
- 将 submodule 替换为本地绝对路径软链接(会导致他人环境不可用)
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,46 @@
|
||||||
|
# 🔌 repo/:外部集成与第三方工具
|
||||||
|
|
||||||
|
`repo/` 用来收纳第三方工具、外部依赖与集成模块(含 Git submodule)。核心原则是:
|
||||||
|
|
||||||
|
- **尽量原样保留**:避免“魔改后不可升级”
|
||||||
|
- **隔离依赖与风险**:外部工具的依赖不要污染主仓库
|
||||||
|
- **可追溯**:来源、许可证、用法要写清楚
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
repo/
|
||||||
|
├── AGENTS.md # 本目录的 Agent 行为准则
|
||||||
|
├── README.md # 本文件(外部工具索引)
|
||||||
|
├── .tmux/ # submodule:oh-my-tmux 配置
|
||||||
|
├── tmux/ # submodule:tmux 源码
|
||||||
|
├── claude-official-skills/ # submodule:Claude 官方 skills 仓库(Anthropic)
|
||||||
|
├── prompts-library/ # Excel ↔ Markdown 转换工具
|
||||||
|
├── chat-vault/ # AI 聊天记录保存工具
|
||||||
|
├── Skill_Seekers-development/ # Skills 制作器
|
||||||
|
├── html-tools-main/ # HTML 工具集
|
||||||
|
├── my-nvim/ # Neovim 配置(含 nvim-config/)
|
||||||
|
├── MCPlayerTransfer/ # MC 玩家迁移工具
|
||||||
|
├── XHS-image-to-PDF-conversion/ # 图片合并 PDF 工具
|
||||||
|
└── backups/ # 历史备份脚本快照
|
||||||
|
```
|
||||||
|
|
||||||
|
## 工具清单(入口与文档)
|
||||||
|
|
||||||
|
- `chat-vault/`:AI 聊天记录保存工具(详见 `chat-vault/README.md`)
|
||||||
|
- `prompts-library/`:提示词 Excel ↔ Markdown 批量互转与索引生成(详见 `prompts-library/README.md`)
|
||||||
|
- `Skill_Seekers-development/`:Skills 抓取/制作器(详见 `Skill_Seekers-development/README.md`)
|
||||||
|
- `html-tools-main/`:HTML 工具集(详见 `html-tools-main/README.md`)
|
||||||
|
- `my-nvim/`:个人 Neovim 配置(详见 `my-nvim/README.md`)
|
||||||
|
- `MCPlayerTransfer/`:MC 玩家迁移工具(详见 `MCPlayerTransfer/README.md`)
|
||||||
|
- `XHS-image-to-PDF-conversion/`:图片合并 PDF(详见 `XHS-image-to-PDF-conversion/README.md`)
|
||||||
|
- `.tmux/`、`tmux/`、`claude-official-skills/`:以 submodule 形式引入的上游仓库
|
||||||
|
|
||||||
|
> 📝 `system-prompts-and-models-of-ai-tools-main-cn/` 已移至 [`prompts/system_prompts/`](../../prompts/system_prompts/)
|
||||||
|
|
||||||
|
## 新增外部工具(最小清单)
|
||||||
|
|
||||||
|
1. 创建目录:`repo/<tool-name>/`
|
||||||
|
2. 必备文件:`README.md`(用途/入口/依赖/输入输出)、许可证与来源说明(如 `LICENSE` / `SOURCE.md`)
|
||||||
|
3. 依赖约束:尽量使用工具自带的虚拟环境/容器化方式,不影响仓库其他部分
|
||||||
|
4. 文档同步:在本 README 增加一行工具说明,保证可发现性
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue