feat: 全面同步本地项目结构与文档更新

This commit is contained in:
tukuaiai
2025-12-16 21:52:14 +08:00
parent 307c6951ee
commit 4780497867
111 changed files with 178 additions and 718 deletions
+19 -15
View File
@@ -1,11 +1,12 @@
# Repository Guidelines
## Project Structure & Module Organization
- 根目录:`README.md` 给出全貌,`Makefile` 封装日常命令,`CONTRIBUTING.md` 说明贡献流程,`LICENSE` 载明协议。保持根目录扁平,避免巨石文件。
- 文档库:`i18n/zh/documents/` 汇总流程、架构与实践(如 `i18n/zh/documents/Templates and Resources/代码组织.md``i18n/zh/documents/Templates and Resources/通用项目架构模板.md``i18n/zh/documents/Methodology and Principles/开发经验.md`),是理解方法论与协作规则的首选入口。新增流程文档时优先放此处并在 README 链接
- 提示词资产`i18n/zh/prompts/` 按角色拆分(system / assistant / coding / user),`libs/external/prompts-library/` 提供 Excel ↔ Markdown 互转工具与脚本目录,便于批量维护提示词,适合作为“单一真实来源”
- 代码与集成:`libs/` 预留核心实现骨架,`common/``database/``external/` 分别对应通用模型、存储适配与外部依赖登记;新增模块需保持分层边界与单一职责,避免跨层调用
- 备份:`backups/` 内含 `一键备份.sh``快速备份.py`,用于本地快照或同步,请先在隔离目录试跑,确认输出路径与权限
## Project Structure & Module Organization
- 根目录:`README.md` 给出全貌,`Makefile` 封装日常命令,`CONTRIBUTING.md` 说明贡献流程,`LICENSE` 载明协议。保持根目录扁平,避免巨石文件。
- 多语言 i18n`i18n/<lang>/` 统一三层结构(documents / prompts / skills)。现有语言:中文 `zh`、英文 `en`、希伯来语 `he`,以及高频使用的西语 `es`、印地语 `hi`、阿语 `ar`、葡语 `pt`、俄语 `ru`、法语 `fr`、德语 `de`、日语 `ja`、韩语 `ko`;新增语言遵循同样层级
- 文档库`i18n/zh/documents/` 仍是默认中文方法论入口(如 `i18n/zh/documents/Templates and Resources/代码组织.md` 等),新增语言文档按需在对应 `documents/` 下创建并保持同步
- 提示词资产:`i18n/zh/prompts/` 按角色拆分(system / assistant / coding / user),`libs/external/prompts-library/` 提供 Excel ↔ Markdown 互转工具与脚本目录,便于批量维护提示词,适合作为“单一真实来源”
- 代码与集成:`libs/` 预留核心实现骨架,`common/``database/``external/` 分别对应通用模型、存储适配与外部依赖登记;新增模块需保持分层边界与单一职责,避免跨层调用
- 备份:`backups/` 内含 `一键备份.sh``快速备份.py`,用于本地快照或同步,请先在隔离目录试跑,确认输出路径与权限。
## Build, Test, and Development Commands
- `make help`:列出所有 Make 目标,是新人快速上手的入口。
@@ -143,10 +144,10 @@ When modifying this repository:
## 文件结构 (File Structure)
```
.
├── .gitignore # Git 版本控制忽略文件配置
├── AGENTS.md # 面向 AI Agent 的贡献与行为准则。
```
.
├── .gitignore # Git 版本控制忽略文件配置
├── AGENTS.md # 面向 AI Agent 的贡献与行为准则。
├── CLAUDE.md # 面向 Claude 模型的上下文与指令。
├── CODE_OF_CONDUCT.md # 项目行为准则。
├── CONTRIBUTING.md # 贡献指南。
@@ -155,10 +156,13 @@ When modifying this repository:
├── Makefile # 项目自动化脚本 (lint, backup 等)。
├── README.md # 项目主文档,包含项目概览、使用指南等。
├── i18n/zh/documents/ # 存放各类说明文档、经验总结和配置。
── ... # 更多文档内容
├── libs/ # 核心库代码
├── i18n/
── zh/{documents,prompts,skills} # 中文主语料与方法论
├── en/{documents,prompts,skills} # 英文版本资产。
│ ├── he/{documents,prompts,skills} # 希伯来语(以色列)
│ ├── es|hi|ar|pt|ru|fr|de|ja|ko/{documents,prompts,skills} # 其他高频语言骨架。
├── libs/ # 核心库代码。
│ ├── common/ # 通用功能和工具库。
│ │ ├── __init__.py # Python 包初始化文件。
│ │ ├── models/ # 数据模型定义。
@@ -185,4 +189,4 @@ When modifying this repository:
├── postgresql/ # PostgreSQL 数据库技能。
├── telegram-dev/ # Telegram Bot 开发技能。
└── ... (其他 10+ 个技能)
```
```