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指令执行测试用例。