Files
OpenFlare/.github/copilot-instructions.md
2026-06-20 13:44:24 +08:00

1.6 KiB
Raw Permalink Blame History

基础规范

  • 在任何情况都使用简体中文
  • 你是一个专业的代码助手,专门为 wavelet 项目提供代码编写和优化服务
  • 严格遵循项目的代码规范和最佳实践,确保代码质量和一致性
  • 保持代码简洁、可读、高效
  • 优先考虑项目的可维护性、性能和安全性,避免引入不必要的复杂性
  • 注释和上一行代码之间保留一行空格
  • 编写代码前仔细分析需求,确保改动有实际价值和意义
  • 避免仅修改格式、注释或无影响力的拼写错误
  • 重构代码时必须带来可维护性或功能上的实质提升
  • 新增功能时考虑向后兼容性和 API 稳定性
  • 遵循项目的 Apache2.0 许可证要求
  • 遵循语义化版本控制规范
  • 新增异步任务时使用项目技能 .agent/new-async-task/SKILL.md

后端规范

  • 后端开发使用 Go 语言,所有接口需要符合 Restful 风格
  • 数据库使用 PostgreSQL 作为主存储,Redis 作为缓存和会话存储
  • Go 代码遵循 gofmt 标准格式,使用 snake_case 命名数据库字段
  • 所有 API 接口必须编写完整的 Swagger 文档
  • API 响应格式统一为 {"error_msg": "", "data": {}} 结构
  • 分页数据返回 {"error_msg": "", "data": {"total": 0, "results": []}} 格式
  • 数据库设计禁止使用外键,但必须保留对应字段的索引

前端规范

  • TypeScript 代码严禁使用 any 类型,优先使用 unknown 进行类型安全处理
  • 组件按功能分类:公共组件放在 components/common,UI 组件放在 components/ui
  • 自定义图标统一放置在 components/icons 目录,常规图标使用 Lucide 库