Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.1 KB

File metadata and controls

30 lines (19 loc) · 1.1 KB

README for AI Agents

开发准则

项目目录结构:

  • 文档:在docs/目录下
  • 后端:在backend/目录下
  • 前端:在web/目录下

开发最佳实践

  • 三思而后行!深度研究,掌握解决问题所必要的信息,然后再动手开发/修复。
  • 设计要具有合理抽象,避免过度抽象。并且要注意代码复用。
  • 实现代码的时候,多问问自己:这代码写在这里合理吗?(架构、正确性等方面) 问问自己,这个实现符合预期吗?
  • 高内聚、低耦合
  • 不得使用workaround的方法绕过问题。要从本质解决问题!
  • 每次更改都要深入思考、了解清楚必要的上下文,再执行。执行之后要反思。
  • 后端开发的时候要时刻保持api行为跟openapi.yaml一致。

开发时的一些常见命令

  • 格式化代码:在项目根目录下运行make fmt,会自动格式化
  • 编译后端:在项目根目录下运行make build-backend.
  • 编译前端:在项目根目录下运行make build-frontend.
  • 查看k3s的信息(使用kubectl的话)要先source .env