软件开发生产线 CODEARTS-软件版本管理:代码提交与分支创建

时间：2024-11-08 17:51:23

代码提交与分支创建

首先，让我们简单了解一下Git的一些基本概念，方便我们更好的理解代码提交与分支合并之间的逻辑关系。

Git有三种状态，你的文件可能处于其中之一：
- 已提交（committed）：数据已经安全的保存在本地数据库。
- 已修改（modified）：修改了文件，但还没保存到数据库中。
- 已暂存（staged）：对一个已修改文件的当前版本做了标记，使之包含在下次提交的快照中。
Git仓库、工作目录以及暂存区域
- Git仓库目录： Git用来保存项目的元数据和对象数据库的地方。这是Git中最重要的部分，从其它计算机克隆仓库时，拷贝的就是这里的数据。
- 工作目录：项目的某个版本独立提取出来的内容。从Git仓库的压缩数据库中提取出来文件，放在磁盘上以供使用或修改。
- 暂存区域：是一个文件，保存了下次将提交的文件列表信息，有时候也被称作“索引”。
基本的Git工作流程如下：
1. 在工作目录中修改文件。
2. 暂存文件，将文件的快照放入暂存区域。
3. 提交更新，找到暂存区域的文件，将快照永久性存储到Git仓库目录。

从上面的基本概念中我们可以了解到，Git的常用基本操作其实很简单，然而同一个工具，不同的用法产生的效果却是迥然不同的，这就要求我们在使用版本控制系统的时候尽量遵守规范，更能使工具发挥出它应有的价值。下面让我们来看看在代码提交和分支合并的时候应该遵守哪些规范：

分支具有描述性
一个好的分支名称应该具有描述性，以便其他人通过分支名称就可以知道它到底是干什么用的。
提交要做对
“好的文章不是写出来的，而是改出来的。”代码提交也是如此。
- 一个提交做好一件事情：
  - 保持每个提交的正确性，不要一系列提交都在不停的修改同一个问题，如果是这样，请将它们合一。
  - 每个提交要独立，不要混杂其他的功能。
- 提交要做小：
- 如果一个提交，修改了过多的内容，那么对检视者就是个灾难。
- 尽可能的拆分，让你的逻辑有延续性，并且可读。
清楚的提交信息
通过写清楚的提交信息，你可以让其他人更容易跟上我们的思路并提供反馈。

提交说明要回答如下问题：
- What——要解决什么问题？
- When——什么情况下会发生？
- How——怎么样解决这个问题？
- Why——为什么这样解决是合理的，比其他解决方法更好？
合并请求的提交要清晰
一个好的合并请求不只是代码的事情，还牵涉到代码审查者对代码的审查，所以开发者不仅要写出好的代码，还需要考虑如何让其他人更清晰的理解自己的想法和思路，这是一个用代码做交流的过程。
- 进行较小的合并请求。
- 每个合并请求只做一件事情。
- 代码行的字数，最好少于80个字。
- 避免重新格式化代码。
- 确保提交的代码能够编译通过并能通过所有测试。
- 详细记录下自己提交的原因。
- 避免重复修改和混入其他的merge。