docs: 更新开发准则和路线图，添加前端开发规范及测试要求
This commit is contained in:
Wenjie Zhang
parent
a8b96dbcf2
commit
4504ed1b5b
18
AGENTS.md
18
AGENTS.md
@ -17,13 +17,17 @@ Don't create helpers, utilities, or abstractions for one-time operations. Don't
|
||||
|
||||
本项目完全通过 Docker Compose 进行管理。所有开发和调试都应在运行的容器环境中进行。使用 `docker compose up -d` 命令进行构建和启动。
|
||||
|
||||
**核心原则**: 由于 api-dev 和 web-dev 服务均配置了热重载 (hot-reloading)，本地修改代码后无需重启容器，服务会自动更新。应该先检查项目是否已经在后台启动（`docker ps`），查看日志（`docker logs api-dev --tail 100`）具体的可以阅读 [docker-compose.yml](docker-compose.yml).
|
||||
**核心原则**:
|
||||
|
||||
1. 由于 api-dev 和 web-dev 服务均配置了热重载 (hot-reloading)，本地修改代码后无需重启容器，服务会自动更新。应该先检查项目是否已经在后台启动（`docker ps`），查看日志（`docker logs api-dev --tail 100`）具体的可以阅读 [docker-compose.yml](docker-compose.yml).
|
||||
|
||||
2. 开发完成之后必须进行 检查 -> 测试 -> Lint，以及端到端测试，测试脚本不完善时应完善脚本。位置：backend/test
|
||||
|
||||
### 前端开发规范
|
||||
|
||||
- 使用 pnpm 管理
|
||||
- API 接口规范：所有的 API 接口都应该定义在 web/src/apis 下面
|
||||
- Icon 应该从 @ant-design/icons-vue 或者 lucide-vue-next （推荐，但是需要注意尺寸）
|
||||
- Vue 中的样式使用 less，非必要情况必须使用[base.css](web/src/assets/css/base.css) 中的颜色变量。
|
||||
- Icon 应该优先从 lucide-vue-next （推荐，但是需要注意尺寸）
|
||||
- 样式使用 less，非特殊情况必须使用[base.css](web/src/assets/css/base.css) 中的颜色变量。
|
||||
- UI风格要简洁，同时要保持一致性，不要悬停位移，不要过度使用阴影以及渐变色。
|
||||
|
||||
|
||||
@ -31,7 +35,6 @@ Don't create helpers, utilities, or abstractions for one-time operations. Don't
|
||||
|
||||
```bash
|
||||
# 代码检查和格式化
|
||||
make lint # 检查代码规范
|
||||
make format # 格式化代码
|
||||
|
||||
# 直接在容器内执行命令
|
||||
@ -39,9 +42,10 @@ docker compose exec api uv run python test/your_script.py # 放在 test 文件
|
||||
```
|
||||
|
||||
注意：
|
||||
- Python 代码要符合 Python 的规范，符合 pythonic 风格
|
||||
- Python 代码要符合 pythonic 风格
|
||||
- 尽量使用较新的语法，避免使用旧版本的语法（版本兼容到 3.12+）
|
||||
- 修改完成后使用 YUXI_SUPER_ADMIN_NAME / YUXI_SUPER_ADMIN_PASSWORD 环境变量调试接口（读取 .env 文件）
|
||||
- 更新 [roadmap.md](docs/changelog/roadmap.md) 文档记录本次修改，多个类似的功能更新已经补充在一起
|
||||
- 开发完成后务必在 docker 中进行测试，可以读取 .env 获取管理员账户和密码
|
||||
|
||||
**其他**：
|
||||
|
||||
|
||||
20
CLAUDE.md
20
CLAUDE.md
@ -17,22 +17,24 @@ Don't create helpers, utilities, or abstractions for one-time operations. Don't
|
||||
|
||||
本项目完全通过 Docker Compose 进行管理。所有开发和调试都应在运行的容器环境中进行。使用 `docker compose up -d` 命令进行构建和启动。
|
||||
|
||||
**核心原则**: 由于 api-dev 和 web-dev 服务均配置了热重载 (hot-reloading)，本地修改代码后无需重启容器，服务会自动更新。应该先检查项目是否已经在后台启动（`docker ps`），查看日志（`docker logs api-dev --tail 100`）具体的可以阅读 [docker-compose.yml](docker-compose.yml).
|
||||
**核心原则**:
|
||||
|
||||
1. 由于 api-dev 和 web-dev 服务均配置了热重载 (hot-reloading)，本地修改代码后无需重启容器，服务会自动更新。应该先检查项目是否已经在后台启动（`docker ps`），查看日志（`docker logs api-dev --tail 100`）具体的可以阅读 [docker-compose.yml](docker-compose.yml).
|
||||
|
||||
2. 开发完成之后必须进行 检查 -> 测试 -> Lint，以及端到端测试，测试脚本不完善时应完善脚本。位置：backend/test
|
||||
|
||||
### 前端开发规范
|
||||
|
||||
- 使用 pnpm 管理
|
||||
- API 接口规范：所有的 API 接口都应该定义在 web/src/apis 下面
|
||||
- Icon 应该从 @ant-design/icons-vue 或者 lucide-vue-next （推荐，但是需要注意尺寸）
|
||||
- Vue 中的样式使用 less，非必要情况必须使用[base.css](web/src/assets/css/base.css) 中的颜色变量。
|
||||
- Icon 应该优先从 lucide-vue-next （推荐，但是需要注意尺寸）
|
||||
- 样式使用 less，非特殊情况必须使用[base.css](web/src/assets/css/base.css) 中的颜色变量。
|
||||
- UI风格要简洁，同时要保持一致性，不要悬停位移，不要过度使用阴影以及渐变色。
|
||||
- 开发完成后，可以在 docker 的 web 文件夹下，运行 npm run format 格式化代码
|
||||
|
||||
|
||||
### 后端开发规范
|
||||
|
||||
```bash
|
||||
# 代码检查和格式化
|
||||
make lint # 检查代码规范
|
||||
make format # 格式化代码
|
||||
|
||||
# 直接在容器内执行命令
|
||||
@ -40,12 +42,12 @@ docker compose exec api uv run python test/your_script.py # 放在 test 文件
|
||||
```
|
||||
|
||||
注意：
|
||||
|
||||
- Python 代码要符合 Python 的规范，符合 pythonic 风格
|
||||
- Python 代码要符合 pythonic 风格
|
||||
- 尽量使用较新的语法，避免使用旧版本的语法（版本兼容到 3.12+）
|
||||
- 更新 [roadmap.md](docs/changelog/roadmap.md) 文档记录本次修改，多个类似的功能更新已经补充在一起
|
||||
- 开发完成后务必在 docker 中进行测试，可以读取 .env 获取管理员账户和密码
|
||||
|
||||
**其他**：
|
||||
|
||||
- 使用 YUXI_SUPER_ADMIN_NAME / YUXI_SUPER_ADMIN_PASSWORD 调试接口
|
||||
- 如果需要新建说明文档（仅开发者可见，非必要不创建），则保存在 `docs/vibe` 文件夹下面
|
||||
- 代码更新后要检查文档部分是否有需要更新的地方，文档的目录定义在 `docs/.vitepress/config.mts` 中
|
||||
|
||||
@ -6,14 +6,12 @@
|
||||
### 看板
|
||||
|
||||
- 集成 LangFuse (观望) 添加用户日志与用户反馈模块，可以在 AgentView 中查看信息
|
||||
- 集成 neo4j mcp （或者自己构建工具）
|
||||
- 增加 paddle-vl 以及 deepseek-ocr 的支持（deepseek-ocr 已支持），重构 OCR 的支持情况，并支持 Paddle 官方的解析 API https://aistudio.baidu.com/paddleocr/task
|
||||
- 系统层面添加 apikey，在智能体、知识库调用中支持 apikey 以支持外部调用
|
||||
- 部分场景应该使用默认模型作为默认值而不是空值
|
||||
- 检索测试中，添加问答
|
||||
- 探索 subagents 的体系
|
||||
- 集成 Memory，基于 deepagents 的文件后端实现
|
||||
- 将 后端代码 和 agents 解耦，agents 作为单独的 package 使用
|
||||
- 添加自定义向量模型和 rerank 模型的配置，在网页上面
|
||||
- 调研轻便的文件展示与编辑器
|
||||
|
||||
### Bugs
|
||||
- 部分异常状态下，智能体的模型名称出现重叠[#279](https://github.com/xerrors/Yuxi-Know/issues/279)
|
||||
@ -26,7 +24,10 @@
|
||||
|
||||
## v0.6
|
||||
|
||||
<!-- 添加到这里 -->
|
||||
|
||||
- 将 后端代码 和 agents 解耦，agents 作为单独的 package 使用
|
||||
- 添加 subagents
|
||||
|
||||
## v0.5
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user