docs: add directory governance docs

This commit is contained in:
tukuaiai
2026-05-04 03:40:08 +08:00
parent f1d6a8980a
commit 4492674a41
21 changed files with 273 additions and 6 deletions
+17
View File
@@ -0,0 +1,17 @@
# tools/ Agent 指南
本目录维护辅助工具、外部工具入口和工具配置。
## 职责
- `tools/config/`:工具与开发环境配置基线。
- `tools/prompts-library/`:提示词 Excel、Markdown、JSONL 转换工具。
- `tools/chat-vault/`AI 聊天记录保存工具。
- `tools/external/`:第三方工具、外部仓库和 Git submodule。
## 约束
- 不把大型第三方源码直接复制进主仓库;新增外部仓库默认使用 submodule。
- 不在工具配置中提交真实密钥、Token 或个人凭证。
- 修改工具行为时,同步更新对应 README、AGENTS 和根目录命令说明。
- 外部源码目录除非任务明确要求,否则不要顺手格式化或批量替换。
+15
View File
@@ -0,0 +1,15 @@
# tools/config/ Agent 指南
本目录维护工具和开发环境配置基线。
## 约束
- 配置文件必须是可公开审查的模板或基线,不得包含真实密钥。
- 本机专用配置应放在用户本地目录,不直接提交到仓库。
- 修改 Codex 配置时,同步更新 `tools/config/.codex/README.md` 和相关 getting-started 文档。
## 验证
```bash
make test
```
+17
View File
@@ -0,0 +1,17 @@
# tools/prompts-library/ Agent 指南
本目录维护提示词格式转换工具,支持 Excel、Markdown 和 JSONL 之间的转换。
## 约束
- 修改转换逻辑前先阅读 `README.md``main.py`,不要猜输入输出格式。
- 不提交生成目录、缓存和临时导出;`prompt_jsonl/` 为 ignored 生成物。
- 新增依赖必须更新本目录的 `requirements.txt` 或脚本专用依赖文件。
- 修改工具后,运行最小可用命令或说明无法运行的原因。
## 常用命令
```bash
cd tools/prompts-library
python3 main.py
```