mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-15 20:08:05 +00:00
chore: assets - retire canvas workflow and document repo sources
This commit is contained in:
@@ -19,8 +19,20 @@ assets/repos/
|
||||
|
||||
- 新增外部依赖(优先 Git submodule,确保可复现)
|
||||
- 更新 submodule 指针(明确记录上游来源与用途)
|
||||
- 用相对软链接把 submodule 暴露到其它资产目录,软链接目标必须仍在仓库内
|
||||
- 为已复制进主仓库的外部源码建立清退计划:上游 URL、保留理由、迁移方式、验证命令
|
||||
|
||||
### 禁止 / 不推荐
|
||||
|
||||
- 直接复制粘贴大型第三方仓库内容到主仓库(优先 submodule)
|
||||
- 将 submodule 替换为本地绝对路径软链接(会导致他人环境不可用)
|
||||
- 提交第三方仓库的构建产物、生成物、运行时二进制或缓存目录
|
||||
- 在主仓库直接魔改第三方源码快照;需要改造时先 fork,再以 submodule 指向 fork
|
||||
|
||||
## 仓库表达决策
|
||||
|
||||
1. **完整外部仓库**:使用 `git submodule`,主仓库只记录 commit 指针。
|
||||
2. **同仓多入口展示**:使用相对软链接,例如 `assets/skills/<name> -> ../repos/<name>`。
|
||||
3. **项目内小工具**:只有在无上游、体量小、与本项目强耦合时才直接追踪源码。
|
||||
4. **生成输出**:默认不跟踪;若必须保留样例,只提交最小样例和生成说明。
|
||||
5. **历史备份**:`assets/repos/backups/` 按项目资产处理,不套用外部仓库清退规则。
|
||||
|
||||
+31
-4
@@ -38,9 +38,36 @@ assets/repos/
|
||||
|
||||
> 📝 系统提示词已迁移到云端表格,入口见 [`assets/prompt/README.md`](../prompt/README.md)。
|
||||
|
||||
## 外部仓库治理分析(2026-04-28)
|
||||
|
||||
目标:`assets/repos/` 只保留外部仓库的可追溯入口,不把大型第三方源码、二进制产物或生成物长期塞进主仓库。GitHub 中优先用
|
||||
Git submodule 表示上游仓库;如需在其它目录暴露入口,则用相对软链接指向 `assets/repos/<repo>/`。
|
||||
|
||||
| 目录 | 当前状态 | 建议 | 原因 |
|
||||
|:---|:---|:---|:---|
|
||||
| `.tmux/` | submodule | 保持 | 上游清晰,主仓库只记录 commit 指针 |
|
||||
| `tmux/` | submodule | 保持 | 上游源码体量较大,已正确用 submodule 表示 |
|
||||
| `claude-official-skills/` | submodule | 保持;`assets/skills/claude-official-skills` 用相对软链暴露 | 官方 skills 应作为外部权威仓库,不复制源码 |
|
||||
| `Skill_Seekers-development/` | 主仓库直接追踪源码 | 高优先级改为 submodule 或移入 `auto-skill` 的单一 vendored 副本 | 已有上游仓库,且当前与 `assets/skills/auto-skill/scripts/Skill_Seekers-development/` 存在重复 |
|
||||
| `my-nvim/` | 主仓库直接追踪源码与二进制 | 高优先级改为 submodule 或清退二进制后只保留索引 | 包含大型 `nvim` 可执行文件,污染主仓库体量 |
|
||||
| `chat-vault/` | 主仓库直接追踪源码 | 中高优先级拆为独立仓库/submodule,或至少清退内嵌第三方监控源码 | 目录体量大,且含 vendored `monitor-tui`/第三方代码 |
|
||||
| `prompts-library/` | 主仓库直接追踪工具源码 | 中优先级拆分:工具用 submodule,生成输出不跟踪 | 上游/工具属性明显,`prompt_jsonl/` 属生成输出且已加入忽略规则 |
|
||||
| `html-tools-main/` | 主仓库直接追踪源码 | 中优先级改为 submodule | README 指向外部 GitHub 仓库,适合用指针表示 |
|
||||
| `XHS-image-to-PDF-conversion/` | 主仓库直接追踪源码 | 中优先级改为 submodule | README 指向外部 GitHub 仓库,适合用指针表示 |
|
||||
| `MCPlayerTransfer/` | 主仓库直接追踪源码 | 暂缓;先补来源/许可证,再决定是否独立仓库化 | 当前未发现明确上游 URL,体量小 |
|
||||
| `backups/` | 主仓库直接追踪备份脚本与存档目录 | 保持;继续禁止删除 `gz/` 存档 | 属本项目历史备份资产,不是外部仓库镜像 |
|
||||
|
||||
## 表达规则
|
||||
|
||||
- 外部完整仓库:优先 `git submodule add <url> assets/repos/<name>`。
|
||||
- 跨目录展示入口:使用相对软链接,例如 `assets/skills/<name> -> ../repos/<name>`。
|
||||
- 不允许:软链接到本机绝对路径、复制大型上游源码、提交构建产物/生成物、提交二进制运行时。
|
||||
- 需要本地改造第三方工具时:优先 fork 后以 submodule 指向 fork;不要在主仓库直接魔改一份不可升级的源码快照。
|
||||
|
||||
## 新增外部工具(最小清单)
|
||||
|
||||
1. 创建目录:`assets/repos/<tool-name>/`
|
||||
2. 必备文件:`README.md`(用途/入口/依赖/输入输出)、许可证与来源说明(如 `LICENSE` / `SOURCE.md`)
|
||||
3. 依赖约束:尽量使用工具自带的虚拟环境/容器化方式,不影响仓库其他部分
|
||||
4. 文档同步:在本 README 增加一行工具说明,保证可发现性
|
||||
1. 优先新增 submodule:`git submodule add <url> assets/repos/<tool-name>`。
|
||||
2. 只在没有上游仓库、且体量小/与本项目强耦合时,才创建普通目录:`assets/repos/<tool-name>/`。
|
||||
3. 必备文件:`README.md`(用途/入口/依赖/输入输出)、许可证与来源说明(如 `LICENSE` / `SOURCE.md`)。
|
||||
4. 依赖约束:尽量使用工具自带的虚拟环境/容器化方式,不影响仓库其他部分。
|
||||
5. 文档同步:在本 README 增加一行工具说明,保证可发现性。
|
||||
|
||||
Reference in New Issue
Block a user