一、命名規則（英文-直譯）

1、檔案命名

資料夾/檔案的命名統一用小寫
保證專案有良好的可移植性，可跨平臺 

2、檔案引用路徑

因為檔案命名統一小寫，引用也需要注意大小寫問題

3、js變數

3.1 變數

命名方式：小駝峰
命名規範：字首名詞
命名建議：語義化

案例：

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

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

3.2 常量

命名方式：全部大寫
命名規範：使用大寫字母和下劃線來組合命名，下劃線用以分割單詞
命名建議：語義化

案例：

const MAX_COUNT = 10;
const URL = 'http://www.foreverz.com';

3.3 函式

命名方式：小駝峰式命名法
命名規範：字首應當為動詞
命名建議：語義化

可以參考如下的動作：

案例：

// 是否可讀
function canRead(): boolean {
  return true;
}
// 獲取名稱
function getName(): string {
  return this.name;
}
 

3.4 類、建構函式

命名方式：大駝峰式命名法，首字母大寫
命名規範：字首為名稱
命名建議：語義化

案例：

class Person {
  public name: string;
  constructor(name) {
    this.name = name;
  }
}
const person = new Person('mevyn');

公共屬性和方法：跟變數和函式的命名一樣。
私有屬性和方法：字首為_(下劃線)，後面跟公共屬性和方法一樣的命名方式。

案例：

class Person {
  private _name: string;
  constructor() { }
  // 公共方法
  getName() {
    return this._name;
  }
  // 公共方法
  setName(name) {
    this._name = name;
  }
}
const person = new Person();
person.setName('mervyn');
person.getName(); // ->mervyn
 

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 的不同狀態或不同版本

二、元件

每個元件的程式碼建議不要超出 200 行，如果超出建議拆分元件
元件一般情況下是可以拆成基礎/ui部分和業務部分，基礎元件一般是承載呈現，基礎功能，不和業務耦合部分。
業務元件一般包含業務功能業務特殊資料等等。

	1 UI元件/基礎元件
	開發的時候注意可拓展性，支援資料傳參進行渲染，支援插槽slot
	設定有mixin，mixin中放了基礎資訊和方法
	2 容器元件
	和當前業務耦合性比較高，由多個基礎元件組成，可承載當前頁的業務介面請求和資料(vuex)
	3 元件存放位置
	（1）ui元件存放在src/components/ 中
	包含xxx.vue和 xxmixin.js 和 readme.md。
	（2）業務元件就放在業務模組部分即可

4 元件通訊
避免資料的分發源混亂，不建議使用eventBus控制資料，應使用props來和$emit來資料分發和傳送
同級元件的通訊一般會有一箇中間容器元件作為橋樑
容器元件作為資料的接受和分發點
5 元件的掛在和銷燬
（1）通過v-if控制組件的掛在和銷燬

<testcomponent v-if='componentActive'> </testcomponent>

（2）通過is控制組件的掛在和銷燬

<component is='componentName'> </component>

6 跨專案元件共用
公共元件存放位置中 定時抽取共用次數多的元件 將他放在公用元件components資料夾下，供下載引用

三、codeReview

1 規則
所有影響到以往流程的功能需求更改發版前都需要codeReview
2 反饋
每次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
在完善中，會繼承自動檢測程式碼，可選輸入發版提交版本基本資訊等等

常用commit的emoji：