前端开发规约

代码版本控制规范

• 开发新功能或修复问题时，应在开发分支上操作，并定期与主分支同步（通常使用  git rebase）以保持代码最新。
• 提交代码前确保通过单元测试。
• Commit 信息应清晰描述改动内容，常遵循以下前缀约定：
  • feat:  新功能
  • fix:  修复问题
  • docs:  修改文档
  • style:  代码格式调整，不改变逻辑
  • refactor:  代码重构
  • perf:  性能优化
  • test:  测试用例增改
  • chore:  工具或其他非代码更改
  • deps:  更新依赖库

文件及命名规范

• 文件夹、文件名及方法名统一小写，长名称使用下划线  _  连接。
• 注释应使用统一的格式，如 korofileheader 插件，但可去除最后更新时间和更新人信息。

代码风格与格式

• 使用 ESLint 或其他代码检查工具自动校验代码风格，遵循特定的属性顺序、缩进、空格等规则。
• ID 和 Class 命名应反映元素内容或功能，优先按内容命名，必要时可结合表现特征。

组件与模块化：

• 组件应保持高内聚低耦合，遵循单一职责原则。
• 模块化组织代码，合理划分文件结构，便于管理和复用。

接口调用规范

• 定义清晰的 API 请求规范，如 GET 用于查询，POST 用于数据的增删改。
• 接口路径全小写，避免大写和下划线，如  /api/v1/users.

浏览器兼容性

• 确保代码在主流浏览器中表现一致，考虑使用 Polyfills 或其他手段处理兼容性问题

技术栈选择与一致性

• 项目应明确指定并遵循一套技术栈，如 Vue、React 或 Angular，并保持项目内部技术选型的一致性。

UI/UX 设计规范

• 遵循设计系统或样式指南，如 Material Design、Ant Design 等，确保界面元素一致性。

前后端协作规范

• 明确接口文档格式和交流流程，如 Swagger/OpenAPI 规范。
• 数据交换格式（如 JSON）和错误处理应有统一标准。