Git/SVN源代码提交规范
在软件开发过程中,使用Git、SVN等源代码版本控制软件有很多好处,例如可以记录所有历史修改过程以方便溯源和还原、可以方便多人多处协作等。但是我们在使用这些源代码版本控制软件时,依然要注意代码提交规范,才能使源代码版本管理如虎添翼。
一、代码仓库的拆分
各代码仓库中的源代码应该相对独立互不影响,被多个其它源代码依赖的源代码也可以独立成库。当一个仓库中的源代码频繁修改而并不过多影响其它仓库时,那么该拆分是相对合理的。仓库的拆分可以按业务拆分、按子系统拆分等等。
二、代码的提交
每次提交应只提交同一Bug/Feature修改的源代码,这样方便溯源历史修改明细,也方便还原历史代码,同时相当于系统变更文档便于接手。建议设立版本号机制更利于代码管理(例如采用GNU版本号规范),同时在提交时备注工单号(可在issues等Bug或项目管理系统中查询)以便查询修改的原因和细节:
主版本号.子版本号[.修正版本号 [build-编译版本号]] 英文对照: Major_Version_Number.Minor_Version_Number[.Revision_Number[.Build_Number]] 示例:1.2.0 build-1234
1.当项目在进行了局部修改或Bug修正时,主版本号和子版本号都不变,修正版本号加1; 2.当项目在原有的基础上增加了部分功能时,主版本号不变,子版本号加1,修正版本号复位为0,因而可以被忽略掉; 3.当项目在进行了重大修改或局部修正累积较多,而导致项目整体发生全局变化时,主版本号加1; 4.另外,编译版本号一般是编译器在编译过程中自动生成的,我们只定义其格式,并不进行人为控制.
三、适时打标签
当子版本号变更时即打标签,修正版本号变更时在提交备注里标记,这样可以对系统历史变更一目了然。