说明

一些很基本的编码规范就不在这里说了，这里仅说明 uninote 项目中最重要的编码规范（有的可能并不常见）

git

• 不要直接在正式分支上修改，另外新建分支，review 后 merge
• 一个任务/bug一个分支，不要全部放一个分支里了
• 如果不是必须，任何开发分支不要 merge 包括 master 在内的任何分支。特别是 xxx 不要 merge xxx-n 这种情况。视频
• git的一个commit只做一件事情，即使这件事情只改了一行代码、配置，并且带上禅道链接
• commit 的标题和正文间空一行，eg：

feat: 导入文章接口

http://zentao.uninote.com.cn/zentao/task-view-20.html

• 代码重构要单独提交到一个commit，如果一个改动需要重构，重构和功能修改分两次commit
• 无意义的代码、输出不要提交
• 不需要的代码直接删除，而不要注释（90%的情况下适用）
• 不要使用 git pull，改用 git pull -r 拉取参数（即使用 rebase 方式 merge 远端分支）
• merge 后要立即 commit，不要再修改后一起 commit。如果有冲突，仅作冲突解决，不要有任何的额外修改
  • merge 节点的 commit msg 自动生成，不要修改；更不要删除冲突清单

格式化

• 不要全局格式化，即使之前的格式有问题，如果确实有必要，参见代码重构
• 新增、修改的代码要保持格式（一般用编辑默认的格式即可）

问题处理：后端 vs 前端

• 对于可前可后的问题，一般建议后端处理：
  • 后端只用处理一次，前端极端情况下要多处处理：安卓、iOS、小程序...
  • 出了问题能够快速修改上线，不用等待审核