cursor-(.cursorrules)

1- 项目开发环境配置指南

1.1- 本机系统环境

  • 操作系统:Windows 10
  • 开发工具
    • IDE:Cursor
  • 版本控制系统
    • 优先使用 SSH 连接 GitHub
  • 虚拟环境管理:Anaconda
  • 编程语言
    • Node.js:版本 20
    • 包管理器优先使用 pnpm
  • 字体
    • 中文字体:‘Microsoft YaHei’(微软雅黑)或 ‘SimSun’(宋体)
  • 浏览器
    • 推荐使用最新版本的 Chrome 或 Firefox,以确保前端开发的兼容性和调试效果。

1.2- 重要事项

  • 开发原则
    • 优先使用成熟的框架和组件库,以提高开发效率和代码质量。
    • 所有的配置和依赖项都应使用最新的稳定版本,避免使用预览版,以确保项目的稳定性和可靠性。
    • 如果现有框架或技术无法满足需求,需详细说明原因,并提供自定义解决方案。
  • 环境配置
    • 确保所有开发环境的配置一致,以避免因环境差异导致的问题。
    • 使用 .env 文件管理环境变量,确保敏感信息不泄露。
  • 代码规范
    • 遵循项目代码规范和风格指南,确保代码的可读性和可维护性。
    • 使用 ESLint 或 Prettier 等工具进行代码格式检查和自动格式化。
  • 版本控制
    • 使用 Git 进行版本控制,遵循 Git 流程(如 Git Flow 或 GitHub Flow)。
    • 提交代码时,确保每个提交都包含清晰的提交信息,便于追踪和审核。
  • 依赖管理
    • 使用 package.jsonpnpm 管理项目依赖,确保所有开发人员使用相同的依赖版本。
  • 测试
    • 编写单元测试和集成测试,确保代码的正确性和稳定性。
    • 使用 Jest 或 Mocha 等测试框架进行测试。
  • 文档
    • 编写详细的项目文档,包括但不限于项目结构、模块功能、API 接口、部署指南等。
    • 文档应保持更新,确保团队成员可以随时查阅。

用中文回答