代码提交规范(试用)
参考
参考百度 echarts 的更新标准。
组成
提交代码的注释由三部分组成:序号、标志、注释内容,具体定义如下:
序号:一次提交多种修改时使用数字标识,如果只有一种修改,序号可写可不写;
-
标识:表示本次提交的性质,可用符号或文字,推荐使用符号。共四种:
-
[+]
或[Feature]
:表示新增功能; -
[^]
或[Enhance]
:表示优化; -
[#]
或[Fix]
:表示修复bug,建议提供bug编号; -
[-]
或[Remove]
:表示移除功能;
-
-
注释内容:
- 注明本次修改的内容,不要写
aaa
等无意义注释 - 可标模块名,也可不标,含义明确即可
- 注明本次修改的内容,不要写
示例
- 单条注释(已新增为例):
//示例1(推荐)
1.[+]实时数据:新增编辑功能;
//示例2
[+]实时数据:新增编辑功能;
//示例3
1.[+]新增实时数据编辑功能;
//示例4
1.[Feature]新增实时数据编辑功能;
- 多条注释:
//示例
1.[+]任务:新增编辑功能;
2.[^]实时数据:优化删除主题功能的配色,以提升用户体验;
3.[#]数据源:修复火狐浏览器无法获取数据的问题(bug-2389);
4.[-]数据源:由于已有批量删除功能,与单体删除功能重复,移除单体删除按钮;