欢迎开发者加入我们的开源社区!以下是参与项目开发的规范与建议:

项目结构概览 🏗️

  • 前端目录/frontend(含 index.htmlstyles.css
  • 后端目录/backend(含 server.jsapi_routes.js
  • 数据存储/database(使用 SQLite 作为默认数据库)
  • 配置文件/config(环境变量与数据库连接配置)
开发流程

开发规范 📜

  1. 代码风格:遵循 Prettier 格式化规则
  2. 命名规范:变量名使用 snake_case,函数名使用 camelCase
  3. 注释要求:关键逻辑需添加中文注释(如 // 初始化数据库连接
  4. 版本控制:使用 Git 提交代码,提交信息需简洁明确
代码规范

协作流程 🤝

  • 新功能开发需先创建 Issue 讨论
  • 每周三进行代码审查(Code Review)
  • 重大更新需通过 Pull Request 合并
  • 请参考 贡献指南 了解详细流程
协作流程

代码提交指南 📦

  • 提交前运行 npm test 确保通过所有测试
  • 使用 git commit -m "简要描述" 提交代码
  • 主分支为 main,开发分支请以 feature/ 开头
  • 提交后需在 Discussions 中说明变更内容
代码提交

如需进一步了解技术细节,请查看 技术文档中心