必要性說明
由於遷移到Github上的項目越來越多,對項目的管理越來越困難。由於各項目命名具有隨意性,用之代表git倉庫名后就很難快速回憶起這個項目的相關細節,通常需要不斷打開某個庫才能有所了解。因此,十分必要對git庫名命名方式進行規范以便於項目的管理。
命名規則
GIT庫名一律采用項目名-類型-年月的形式。其中對項目名的規范如下:
庫名中不得出現下述規定的字符- \ @ ! # $ % ^ & * () [] {} | \ ; : '' ’ , 。 《 》 < > · ~ 。
庫名應盡量避免使用 名.名的形式。
庫名應盡量使用英文,禁止使用中文字符。一般情況下,庫名中出現的各個單詞的首字母應使用大寫。各個單詞不能使用連接符 -連接;如有必要,應使用下划線 _ 。
縮寫的單詞一律使用大寫。
對類型的規定如下:
TST——測試項目
BC——已完成項目
SUS——被擱置項目
ING——正在進行的項目
TST-BC——已完成的測試項目
TST-SUS——被擱置的測試項目
TST-ING——正在進行的測試項目