Skip to content

开发规范

git 提交规范

commit含义
feat新功能(feature)
fix修补 bug
bug此项特别针对 bug 号,用于向测试反馈 bug 列表的 bug 修改情况
chore细小的变动或构建过程或辅助工具的变动
merge合并分支, 例如: merge(前端页面): feature-xxxx 修改线程地址
style格式(不影响代码运行的变动)
perf性能优化
test增加测试
refactor重构(即不是新增功能,也不是修改 bug 的代码变动)
revert撤销,版本回退
docs文档(documentation)
build打包
release发布
deploy部署

debug 提交规范

  1. fix:pingcode bug号 + 更改内容
  2. pingcode 评论影响范围

开发规范

  1. 代码命名与注释
  • 变量和函数命名应清晰简洁,遵循驼峰命名法
  • 添加必要的注释,帮助理解代码逻辑
  1. 代码清理与维护
  • 重构或功能调整后,及时删除无用代码
  • 定期进行代码审查,保持代码质量
  1. 公共组件管理
  • 修改公共组件需团队讨论,达成一致后再进行
  • 公共组件设计前收集团队需求,确保易于维护
  1. 代码复用与封装
  • 遇到重复功能,务必进行封装,避免冗余
  • 遵循模块化开发原则,提升可维护性
  1. 开发流程与协作
  • 开发前进行需求分析,确保理解无误
  • 使用项目管理工具跟踪任务进度
  • 代码合并需通过审查,确保无冲突,严格版本控制
  1. 性能与安全
  • 慎用定时器,避免内存泄漏等问题
  • 优化渲染性能,提升用户体验