Git源代码管理

0.如果你的团队来了一个新队员，有一台全新的机器， 你们是否有一个文档，只要设置了相应的权限，她就可以根据文档，从头开始搭建环境，并成功地把最新、最稳定版本的软件编译出来，并运行必要的单元测试？ （在这过程中，不需要和老队员做任何交流）

 

我们有相应文档，只要按照文档要求，学习预备知识、搭建开发环境、同步最新代码并启动服务，并对无法正常服务的几种可能原因进行调试，大多数情况下，可以将最新、最稳定版本的软件编译出来。

文档地址是：

https://github.com/buaaclubs-team/share-and-notify/wiki/%E5%86%99%E7%BB%99%E6%96%B0%E4%BA%BA%E7%9A%84%E6%8C%87%E5%AF%BC

 

1. 你的团队的源代码控制在哪里？用的是什么系统？如何处理文件的锁定问题？

   场景： 程序员果冻正在对几个文件进行修改，实现一个大的功能， 这时候，程序员小飞也要改其中一个文件，快速修复一个问题。怎么办？

    一个代码文件被签出 (check out) 之后，另一个团队成员可以签出这个文件，并修改，然后签入么？

   有几种设计，各有什么优缺点？

   例如，签出文件后，此文件就加锁，别人无法签出；  或者， 所有人都可以自由签出文件

 

　　

　我们团队的源代码控制在Github上，使用的是git提供的一系列服务。

　关于文件的锁定方面，我们运用的是git的机制，就是任何人都可以在任何时刻将一个代码文件签出，但是，迁入的时候是需要先pull的。就是说，每次迁入的时候，都需要保证当前自己的代码是已经合并了远端的代码，也就可以保证每次迁入的一定是最新的。

 

2. 如何看到这个文件和之前版本的差异？ 如何看到代码修改和工作项 （work item），缺陷修复 （bug fix) 的关系。

   场景： 程序员果冻看到某个文件被修改了，他怎么看到这个文件在最近的修改究竟改了哪些地方？ 

   场景： 程序员果冻看到某个文件在最新版本被改动了100 多行， 那么和这100多行对应的其他修改在什么文件中呢？ 这个修改是为了解决哪些问题而作的呢？ 那些问题有工作项 （work item，issue），或者bug 来跟踪么？

 

   

  2.1  查看版本的差异

 

我们在红色框框里可以看到改变的文件

 

 

彩色的部分是添加或者修改的部分

 

2.2 Issue的用途

我们到官网上看看issue的用途吧~

 

issue可以很好的跟踪任务，进度，bugs的情况。我们使用issue来管理我们的任务，进度和bugs。

 

2.3 github上commit与issue关联

a.首先，我们先建立一个issue吧~

点击new issue

 

 

建立新的issue后，我们可以在issues里看到所有建好的issue

箭头指向的就是我们新建的issue哟~

 

 

 

b.在commit时，关联issue

在commit的时候，commit message写上issue #[issue号]

如果要是命令行的话，就是 git commit -m ‘Issue #6: [可以加上你自己的Description]’

 

 

 

c.push之后，我们便可以看到，我们刚刚的commit关联了Issue #6

 

 

d.点击#6，我们就可以看到在该issue下面有我们的修改~

 

 

e.如果该issue已经完成，我们可以点击close issue

 

之后，该issue算已经完成啦

 

 3. 如果某个文件在你签出之后已经被别人修改，并且签入了，那么你在签入你的修改的时候， 如何合并不同的修改（merge)? 你用了什么工具来帮助你？

　　一般情况下，git pull将远程代码pull到本地后，git会按照默认的合并规则，自动对修改进行合并。其中，对于无法自动合并的情况，git会在发生冲突的地方打上标记，使用华丽丽分割线将发生冲突的代码分割开来，然后我们需要做的就是手动对这些修改进行合并，选择保留哪些内容，删除哪些内容，最后，重新add，commit，再将你的修改push上去。

　　在后端的编写中，后端三个人各自负责不同的模块，基本上没有发生冲突的问题。但是在编写数据库迁移文件时，三个人都写了一部份数据库的迁移，这在合并到master分支上出现了一些问题。而且由于我们的代码不是一次写好的，总会存在许多问题，所以如果都push到master分支上，就会使master分支上的代码有许多问题，然后我又会把别人有问题的代码pull到自己本地，这样大家的代码都是会变得有问题了。

　　为此，我们后端的解决方法就是，首先由一个人将数据库迁移全部写好，放到master分支上，之后的人在写代码的时候就没有必要再去写数据库迁移了。之后大家clone master分支上的代码，并在远程建立各自的分支，push到自己的分支上去，最后再合并到master分支上。这样做有许多好处：由于三个人写的部分相关性不是很密切，所以并不关心别人写的代码，其次这样保证master分支上的代码是稳定的版本，至少是没有错误的。最后，大家，可以每天迁入代码，不必每次都要pull别人有问题的代码了，而且即使自己目前的代码有问题，也不会影响到其他人。

4. 你有20个文件都是关于同一个功能的修改，你要如何保证这些文件都同时签入成功（修改的原子性），或者同时签入不成功？

    场景： 程序员果冻要签入 20 个文件，他一个一个地签入， 在签入完5 个 .h 文件之后， 他发现一些 .cpp 文件和最新的版本有冲突，他正在花时间琢磨如何合并... 这时候， 程序员小飞从客户端同步了所有最新代码， 开始编译， 但是编译不成功 - 因为有不同步的 .h 文件和 .cpp 文件！  这时候， 别的程序员也来抱怨同样的问题，果冻应该怎么办？

　　

　　我们统一采用git将本地代码上传至github。

　　Git 在每次上传之前会检查远程分支，如果已更新而本地未同步，它会要求用户先pull同步后，再进行Push。所以不存在情景中提到的的状况。

而在通过git push 将本地代码上传之前，均需要将本地的改变提交至本地仓库，commit操作会生成一个commit对象，所以Push时只是将这次commit对象提交至远程分支。而git会随时保证数据的完整性，一旦上传过程中出现问题（断网），会撤销掉之前的上传记录。

5. 你的PC 上有关于三个功能的修改，但是都没有完成，有很多文件处于半完工的状态，这时你要紧急修改一个新的 bug，如何把本地修改放一边，保证在干净的环境中修改这个 bug, 并成功地签入你的修改 --- changelist management。

　　先另外建立一个分支，通过git pull将远程分支代码拉到本地进行BUG修改，之后在同之前的分支进行合并，在通过git push上传至远程分支。

6. 如何给你的源代码建立分支？

    场景：你们需要做一个演示，所以在演示版本的分支中对各处的代码做了一个临时的修改， 同时，主要的分支还保持原来的计划开发。 你们怎么做到的？ 在演示之后，演示版本的有些修改应该合并到主分支中，有些则不用，你们是怎么做到的？

    场景： 你们的软件发布了，有很多用户，一天，一个用户报告了一个问题，但是他们是用某个老版本，而且没有条件更新到最新版本。 这时候，你如何在本地构建一个老版本的软件，并试图重现那个问题？

 

　　

　　建立分支利用git branch 分支名 操作，跳转到相应分支用git check out 操作，分支合并用git merge 操作，在确认了修改以后，进行git commit 操作提交。

　　场景一：可以用git branch demo 建立一个新的分支，把主分支（main）里的东西clone到新的分支里进行修改，在修改完之后，用git checkout main 进入到main分支，然后用git merge demo 命令进行合并，选择需要保留的内容，最后用git commit 命令提交修改。

　　场景二：每一次提交都会有一个commit代码，比如某次提交的名字是alpha，现在版本是beta版本，只需要git checkout 到alpha分支下，然后运行用户提示的问题，既可以再现问题。

7. 一个源文件，如何知道它的每一行都是什么时候签入的，为了什么目的签入的 （解决了哪个任务，或者哪个bug）？

   场景： 一个重要的软件忽然出现崩溃的情况， 程序员果冻经过各种debug手段，发现问题是在某一个文件中有一行代码似乎显然出了问题，但是这个模块被很多其他模块调用，这行代码是什么时候，为了什么目的，经过谁签入的呢？如果贸然修改，会不会导致其他问题呢？ 怎么办？

　　

　　我们可以通过github提供的功能来得知代码的行是在什么时候迁入的，迁入的目的等。

　　我们可以知道当前的这些代码是如何被修改的，如下图所示：

 　　

　　另外我们可以通过文件后面来知道每个文件最后是由谁，在哪个commit修改的，如下图所示：

　

8. 如何给一个系统的所有源文件都打上标签，这样别人可以同步所有有这个标签的文件版本？

   代码每天都在变， 有时质量变好，有时变差，我们需要一个 Last Known Good （最后稳定的好版本） 版本， 这样新员工就可以同步这个版本， 我们如果需要发布，也是从这个版本开始。那么如何标记这个 Last Known Good 版本呢？ 

　

　　git标签

 

　　标签常常用在标记某个历史状态的关键点，一般用版本号例如v1.1或者日期1222等具有标志性的简单标记来记录。

　　我们创建标签号的时候使用v1.2这种格式的，当我们写出一个Last Known Good （最后稳定的好版本） 版本的时候，我们会在这次的标签后加上后-lkg缀表示

　　这个是lask known good版本，

　　(1).列出git中现有的标签

　　git tag

　　结果会显示所有标签

 

　　(2).查找特定序列的标签

　　git tag -l v1.2.*

　　结果会显示 v1.2.3 v1.2.4等等之类符合格式的标签

 

　　(3).创建标签

　　git tag -a v1.1 -m 'version 1.1'

　　-m是标签信息

 

　　(4).创建标签成功后可以查看信息

　　git show v1.1

 

　　(5).创建轻量级标签

　　git tag v1.2

　　什么都不加，使用git show查看的时候不会显示那么多信息

 

　　(6).对之前某次提交贴个标签

　　git tag -a v1.3 8d8ds3r

　　后面跟上那次提交的校验和或者部分校验和即可。

 

　　(7).共享标签

　　在push的时候默认不会将标签上传到远程服务器上，所以要

　　git push --tags

　　这样会将所有标签一并传到服务器上，别人在克隆或者同步git仓库的话，标签也会获取下来

 

　　(8).push指定标签

　　git push v1.2

 

　　(9).查看指定标签的代码状态

　　git checkout v1.2

 

　　(10).恢复代码到某个标签点

　　在git show之后获取校验值，然后通过git reset回退代码

 

　　(11).删除标签

　　git tag -d 制定标签

 

　　比如把本次提交了tag文档之后的仓库加一个标签

　　首先

　　git tag v1.1

　　创建了一个新的v1.1标签，然后

　　git show v1.1

　　查看了标签信息和内容(?为中文)，然后

　　git push v1.1

　　把本标签下的文件push上去

　　提交之后的v1.1标签里的内容如下

9. 你的项目的源代码和测试这些代码的单元测试，以及其他测试脚本都是放在一起的么？ 修改源代码会确保相应的测试也更新么？你的团队是否能部署自动构建的任务？

    在签入之前，程序员能否自动在自己的机器上运行自动测试，以保证本地修改不会影响整个软件的质量？

    在程序员提交签入之后，服务器上是否有自动测试程序， 完成编译，测试，如果成功，就签入，否则，就取消签入？

    团队是否配置了服务器，它自动同步所有文件，自动构建，自动运行相关的单元测试，碰到错误能自动发邮件给团队

 

　　单元测试的代码是和项目的源代码放在一起的，因为rails自带单元测试框架，放在test目录下，test/model下存放的是模型的单元测试，test/controller目录下存放的是编写的功能测试，修改源代码后要运行之前的测试，只有之前的测试都通过后，才能push代码到远程。

　　我们目前并没有做自动测试的设置，需要手动输入rake test指令执行测试用例。