mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-17 21:08:05 +00:00
chore: repo - flatten tool mirrors
This commit is contained in:
+16
-11
@@ -1,21 +1,26 @@
|
||||
# repo/ 目录 Agent 指南
|
||||
|
||||
本目录用于收纳**可执行代码与外部依赖镜像**,将“知识库/提示词/技能”与“代码/第三方工具”做物理隔离,便于迁移与审计。
|
||||
本目录用于收纳 **外部工具/第三方项目**(含 Git submodule),保持“主仓库资产”和“外部依赖”边界清晰、可审计、可更新。
|
||||
|
||||
## 目录结构(当前)
|
||||
## 目录结构(约定)
|
||||
|
||||
```text
|
||||
repo/
|
||||
├── AGENTS.md
|
||||
└── libs/
|
||||
├── external/ # 第三方工具与外部集成(含 Git submodule)
|
||||
└── common/
|
||||
└── utils/
|
||||
└── backups/ # 历史备份脚本快照(README + 脚本)
|
||||
├── AGENTS.md # 本文件(目录级行为准则)
|
||||
├── README.md # 外部工具索引
|
||||
├── .tmux/ # submodule:oh-my-tmux 配置
|
||||
├── tmux/ # submodule:tmux 源码
|
||||
└── claude-official-skills/ # submodule:Claude 官方 skills 仓库(Anthropic)
|
||||
```
|
||||
|
||||
## 操作规范
|
||||
|
||||
- `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
Reference in New Issue
Block a user