当前位置:首页 > 技术积累 > 正文内容

Git/SVN源代码提交规范

竹林之风2年前 (2022-09-22)技术积累2558

        在软件开发过程中,使用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.另外,编译版本号一般是编译器在编译过程中自动生成的,我们只定义其格式,并不进行人为控制.

三、适时打标签

        当子版本号变更时即打标签,修正版本号变更时在提交备注里标记,这样可以对系统历史变更一目了然。


扫描二维码推送至手机访问。

版权声明:本文由久爱编程网发布,如需转载请注明出处。

本文链接:https://www.9icode.com/index.php/post/372.html

分享给朋友:

相关文章

在线支付子模块的设计与实现

在线支付子模块的设计与实现

        一个在线交易系统需要各种支付方式方便客户付款,这些支付方式按场景可分为在线支付和线下现付。线下现付常见的有货到付款、邮局汇款、银行电汇等非实时方...

ASP.NET实现HTTP长轮询(一)——WebForm

ASP.NET实现HTTP长轮询(一)——WebForm

        本文主要描述如何在ASP.NET WebForm中实现长轮询:(1)在ASP.NET WebForm的aspx文件中设置如下指令即可实现异步的ASP.NET WebForm:<%...

ASP.NET中报“无法在已发送HTTP标头之后进行重定向”异常问题解决

ASP.NET中报“无法在已发送HTTP标头之后进行重定向”异常问题解决

        ASP.NET中报“无法在已发送HTTP标头之后进行重定向”异常时,其中一个原因是:在已经重定向后又重定向。在ASP.NET中实现重定向有以下几...

ASP.NET中报“无法在已发送HTTP标头之后设置状态”异常问题解决

ASP.NET中报“无法在已发送HTTP标头之后设置状态”异常问题解决

        ASP.NET中报“无法在已发送HTTP标头之后设置状态”异常,是因为设置Response的StatusCode之前,程序已设置响应标头。可从以...

ASP.NET网站自定义错误处理及其它安全相关

ASP.NET网站自定义错误处理及其它安全相关

        ASP.NET网站在运行过程中总是有可能报错,例如404等HTTP错误、500等程序异常。在IIS托管并报错的情况下,网站的默认行为依次是:(1).NET运行时接收并处理的部分显示.N...

从被扫描记录看网站安全应该注意的一些细节

从被扫描记录看网站安全应该注意的一些细节

1、尽可能地隐藏服务器真实IP,减少攻击目标。例如使用负载均衡、网关等作为门户,由负载均衡或网关转发到后端服务器。2、服务器必须开放的服务(除HTTP、HTTPS等为公众开放的服务外),尽可能改为其它较大的不常用的端口号,这样攻击者需要扫描...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。