开发规范介绍
概述
本节汇集了 beisi-tech 团队的开发规范和最佳实践指南，旨在帮助团队成员编写高质量、可维护的代码，提升团队协作效率。
这些规范涵盖了从项目贡献流程、代码提交规范、命名约定到文案排版等多个方面，为团队提供统一的开发标准。
规范内容
📋 项目贡献指南
面向所有参与公司项目开发的成员，详细说明了：
- 如何加入 beisi-tech 组织
- Git 和 GitHub Desktop 的使用
- 从克隆仓库到提交 PR 的完整开发流程
- Issue 关联和 PR 修改规范
- 开发过程中的注意事项
适用对象：新员工、所有项目贡献者
📝 Commit 提交规范
规定了 Git 提交信息的格式和规范，包括：
- Commit 类型说明（feat、fix、docs、style 等）
- 提交信息的编写格式
- Prettier 代码格式化工具的使用
适用对象：所有开发人员
🏷️ 开发命名参考
涵盖项目中各类命名的最佳实践：
- 文件夹和文件命名规范
- 变量、函数、类的命名约定
- 数据库表和字段命名规则
- API 接口命名规范
原则：优先考虑小写、下划线，避免使用中划线
📂 项目结构示例
提供标准的项目目录结构示例：
- 前后端分离项目的目录组织
- 静态资源、源代码的存放位置
- 配置文件和文档的规范布局
作用：帮助团队保持项目结构的一致性
✍️ 中文文案排版指北
中文技术文档的排版规范：
- 中英文混排的空格规则
- 标点符号使用规范
- 数字和单位的书写方式
- 专有名词的正确写法
适用场景：编写文档、README、注释、用户界面文案
使用建议
对于新成员
- 首先阅读 项目贡献指南，了解开发流程
- 熟悉 Commit 提交规范 和 开发命名参考
- 在编写代码前查看相关规范，养成良好习惯
对于团队管理者
- 在代码审查时参照这些规范
- 定期更新和完善规范内容
- 确保团队成员了解并遵循这些规范
对于所有开发者
- 将规范作为日常开发的参考手册
- 不确定时查阅相关规范
- 发现问题或有改进建议时及时反馈
规范的重要性
遵循统一的开发规范能够：
- ✅ 提高代码可读性：统一的风格让代码更容易理解
- ✅ 减少沟通成本：团队成员使用相同的术语和约定
- ✅ 降低维护成本：规范的代码更容易维护和重构
- ✅ 提升协作效率：减少因风格不一致导致的冲突
- ✅ 保证项目质量：规范的流程确保代码质量
持续改进
这些规范会随着团队实践不断优化和完善。如果你有任何建议或发现问题，欢迎：
- 在相关 Issue 中讨论
- 提交 PR 改进规范文档
- 联系项目维护人员
让我们一起打造更好的开发规范！💪