Github库名命名规范

一、必要性说明

由于迁移到Github上的项目越来越多，对项目的管理越来越困难。由于各项目命名具有随意性，用之代表git仓库名后就很难快速回忆起这个项目的相关细节，通常需要不断打开某个库才能有所了解。因此，十分必要对git库名命名方式进行规范以便于项目的管理。

二、命名规则

GIT库名一律采用项目名-类型-年月的形式。其中对项目名的规范如下：

库名中不得出现下述规定的字符- \ @ ! # $ % ^ & * () [] {} | \ ; : '' ’ ， 。 《 》 < > · ~ 。
库名应尽量避免使用 名.名的形式。
库名应尽量使用英文，禁止使用中文字符。一般情况下，库名中出现的各个单词的首字母应使用大写。各个单词不能使用连接符 -连接；如有必要，应使用下划线 _ 。
缩写的单词一律使用大写。

对类型的规定如下：

TST——测试项目

BC——已完成项目

SUS——被搁置项目

ING——正在进行的项目

TST-BC——已完成的测试项目

TST-SUS——被搁置的测试项目

TST-ING——正在进行的测试项目

Github库名命名规范相关推荐

python字符串常用方法变量名命名规范
python变量名命名规范 python变量名命名规范 1.一般以字母(大写,小写字母均可以)开头,例如:myname,Myname 2.后面可以使用下划线_或者数字例如:My_name 3.大小写 ...
java包名命名规范
做开发的都知道,一个好的项目规范可以提高开发效率以及后期的维护.自己手上有个项目,里面规范很乱,自己在对它进行二次开发的时候很蛋疼,它没有相应的文档,公司给我的就只有一个项目源码,其中的关系还要自己去 ...
实验送样、数据分析样品、组名命名规范
俗话说巧妇难为无米之炊,而样品就是"米",没有样品,就无法开展实验,无法获得数据,无法毕业,无法发文章.鉴于样品的重要性,非常有必要对样品进行详细且规范的记录,方便他人也方便自己. ...
用户名和计算机名命名规范
本文中使用到的规范仅适用于公司内部使用,与国际标准无关,仅供参考. 一.用户名命名规范: 总纲:用户名规范包括通用规范和特殊原则. A.通用规范: a.用户名只能由字母.数字和下划线组成,且必须以字母 ...
hive表名命名规范_数据仓库开发规范
背景为了避免底层业务变动对上层需求影响过大,屏蔽底层复杂的业务逻辑,尽可能简单.完整的在接口层呈现业务数据,建设高内聚松耦合的数据组织,使数据从业务角度可分割,显得尤为重要.从整个集团业务条线出发, ...
元器件_封装库_命名规范
@/" 1> 基本原则 1.1> 命名格式 1.2> 数值 2> 贴装器件 2.1> [SR/C/L]电阻/电容/电感 2.11> [TSSOP] 薄的缩 ...
Linux主机名命名规范
主机名字允许包括:大小写字母,数字,连字符注意:但是不能包含下划线.不能以数字开头. 如比51cto 当主机名字就是不正确的. 主机名最好也不要是这种结构:fenghao.cn 这样的主机名也是 ...
java包名命名规范[【转】
indi : 个体项目,指个人发起,但非自己独自完成的项目,可公开或私有项目,copyright主要属于发起者. 包名为"indi.发起者名.项目名.模块名.--". per ...
php函数名命名规范,PHP语言的命名规则
PHP语言的命名规则想要了解和掌握PHP语言,我觉得掌握PHP语言的命名规则很重要,下面小编为大家介绍关于PHP语言的命名规则,欢迎大家阅读! PHP语言的命名规则 1. 类命名使用大写字母作为词 ...

Github库名命名规范

Github库名命名规范

一、必要性说明

二、命名规则

Github库名命名规范相关推荐

最新文章

热门文章