关于命名

一、命名规则（英文-直译）

1、文件命名

文件夹/文件的命名统一用小写
保证项目有良好的可移植性，可跨平台
相关参考（http://www.ruanyifeng.com/blog/2017/02/filename-should-be-lowercase.html）

2、文件引用路径

因为文件命名统一小写，引用也需要注意大小写问题

3、js变量

3.1 变量

命名方式：小驼峰

命名规范：前缀名词

命名建议：语义化

// 友好
let maxCount = 10; 
let tableTitle = 'LoginTable';

// 不友好
let setCount = 10;
let getTitle = 'LoginTable';

3.2 常量

命名方式：全部大写

命名规范：使用大写字母和下划线来组合命名，下划线用以分割单词

命名建议：语义化

3.3 函数

命名方式：小驼峰式命名法。

命名规范：前缀应当为动词。

命名建议：语义化

可以参考如下的动作

3.4 类、构造函数

命名方式：大驼峰式命名法，首字母大写

命名规范：前缀为名称。

命名建议：语义化

3.5 css（class、id）命名规则BEM

我们还是使用大团队比较常用的BEM模式
（1）class命名使用BEM其实是块（block）、元素（element）、修饰符（modifier）的缩写，利用不同的区块，功能以及样式来给元素命名。这三个部分使用__与–连接（这里用两个而不是一个是为了留下用于块儿的命名）。
命名约定的模式如下：

.block{}
.block__element{}
.block--modifier{}

block 代表了更高级别的抽象或组件
block__element 代表 block 的后代，用于形成一个完整的 block 的整体
block--modifier代表 block 的不同状态或不同版本

三、组件

每个 Vue 组件的代码建议不要超出 200 行，如果超出建议拆分组件
组件一般情况下是可以拆成基础/ui部分和业务部分，基础组件一般是承载呈现，基础功能，不和业务耦合部分。

业务组件一般包含业务功能业务特殊数据等等

1 UI组件/基础组件

开发的时候注意可拓展性，支持数据传参进行渲染，支持插槽slot

设置有mixin，mixin中放了基础信息和方法

2 容器组件

和当前业务耦合性比较高，由多个基础组件组成，可承载当前页的业务接口请求和数据(vuex)

3 组件存放位置

（1）ui组件存放在src/components/ 中

包含xxx.vue和 xxmixin.js 和 readme.md

xxx.vue 表示ui部分
xxmixin.js 表示js部分
readme.md 中描述组件的基本信息

四、codeReview

1 规则

所有影响到以往流程的功能需求更改发版前都需要codeReview

2 执行者

初级程序员可由中级程序员的执行codeReview
中级程序员可由高级程序员执行codeReview
以此类推

3 反馈

每次codereView都需要有反馈，要对本次codeReview负责

反馈内容基本如

功能：本次主要是修改了什么功能或者bug
模块：本次发版影响的模块
代码问题：codereview过程中发现的代码问题，比如代码性能，写法，代码风格等等
业务问题：比如发现了某某影响到其他模块的逻辑问题，如果没有发现就写。无
五、git规范

1 分支

命名

master: master 分支就叫master 分支，线上环境正在使用的，每一次更新master都需要打tag
test: test分支就供测试环境使用的分支
develop: develop 分支就叫develop 分支
feature: feature 分支 咱们暂时可以按 feature/name/version 这种命名规范来，后面有更好的命名规范咱们再改。version 表示
当前迭代的版本号，name 表示当前迭代的名称
hotfix: hotfix 分支的命名我们暂时可以按 hotfix/name/version 这种来进行命名,verison表示这次修复的版本的版本号，name表示本次热修复的内容标题
斜杠 的方式 在source-tree中有归类的作用

2 提交模版 kz-commit

在完善中，会继承自动检测代码，可选输入发版提交版本基本信息等等