Files
llm-in-text/AGENTS.md

3.6 KiB
Raw Blame History

rules.md

在构建这个LLM应用网页时你需要基于VUE3开发。我需要前端只运行渲染和数据回传后端负责llm api调用类似copilet的auto inline suggustions实现和数据解析。

重要 : 在回复用户消息时,一定要使用中文

指导原则

  • 不要擅自用npm或者yarn运行网页你既看不到网页的内容也无法阻止命令暂停。但是你可以用npm run build检查代码。
  • 应该保证代码效率,不多定义变量,不写冗余注释,把降低延迟放在第一位。
  • 每次完成任务前都要反复阅读检查代码,确保代码准确无误。
  • 尽量不要搜索关键字,而是了解代码结构后查询整个问题代码明确问题所在。
  • @/milkdown-docs/ 代表milkdown的最新官方文档不要修改涉及到前端编辑器的指令时要核对官方文档。

仓库指南

语言约定

项目文档、日志、错误提示以及对外返回的文字信息统一使用 中文。前端 UI 默认展示中文,若需多语言支持请在相应模块实现。

项目结构 & 模块组织

backend/          # FastAPI 后端Python
    ├─ main.py    # API 入口
    ├─ llm.py    # LLM 包装工具
    ├─ prompt.py # Prompt 构建辅助
    └─ tests/    # pytest 测试套件
public/           # 前端静态资源
src/              # 前端源码Vite + React
dist/             # 构建产出(生成文件)

生产代码主要位于 backend/Pythonsrc/JS/TS。测试文件与被测模块并置。

构建、测试、开发命令

命令 说明
npm install 安装前端依赖
npm run dev 启动 Vite 开发服务器
uvicorn backend.main:app --reload 本地运行 FastAPI 服务
pytest 运行 Python 测试套件
npm run build 生成生产环境构建产物至 dist/

编码风格 & 命名约定

  • Python:使用 4 空格缩进,snake_case 命名函数/变量,PascalCase 命名类。提交前请使用 ruff/black 格式化。
  • JavaScript/TypeScript:使用 2 空格缩进,camelCase 命名变量/函数,PascalCase 命名 React 组件。使用 eslintprettier 检查。
  • 文件名采用全小写加短横线,例如 my-module.pymy-component.tsx

测试指南

  • 后端使用 pytest,测试文件放在对应模块目录下,命名为 test_<module>.py
  • 目标覆盖率 ≥ 80%pytest --cov=backend)。
  • 在虚拟环境中运行:pip install -r backend/requirements.txt && pytest

提交 & Pull Request 规范

  • 提交信息遵循 Conventional Commitsfeat: 新功能、fix: 修复、docs: 文档、refactor: 重构等。
  • PR 必须包含:
    • 与提交信息匹配的标题。
    • 关联的 IssueFixes #123)。
    • UI 变更或 API 示例的截图/示例。
    • 所有 CI 检查(代码检查、测试、类型检查)均通过。

安全 & 配置建议

  • 敏感信息请放入 .env 并确保已在 .gitignore 中。
  • 按照 backend/main.py 中的实现,对上传文件的大小和类型进行校验,防止滥用。
  • 定期审计依赖安全(npm auditpip-audit)。