github与项目

1. GitHub

1. 简介
   gitHub是一个面向开源及私有软件项目的托管平台，因为只支持git 作为唯一的版本库格式进行托管，故名gitHub。gitHub于2008年4月10日正式上线，除了git代码仓库托管及基本的 Web管理界面以外，还提供了订阅、讨论组、文本渲染、在线文件编辑器、协作图谱（报表）、代码片段分享（Gist）等功能。

2. GitHub 多人协作开发 三种方式：

• Fork 方式
  开发者 fork 自己生成一个独立的分支，跟主分支完全独立，pull代码后，项目维护者可根据代码质量决定是否merge代码

• 组织
  组织的所有者可以针对不同的代码仓库建立不同访问权限的团队。
  Accounts Settings => Organizations =>Create new Organizations 新建一个组织 然后添加项目成员，根据提示设置完毕即可。
  新建一个Repository 新建完毕后 进入Repository的Settings =>Collaborators 在Teams下面点击刚创建的组织 比如eveloper-51/owners里面就可以添加或者remove组织成员

• 合作者
  代码仓库的所有者可以为单个仓库增加具备只读或者读写权限的协作者。
  合作者方式比较实用，也很方便，新建一个Repository，完毕之后，进入Repository的Settings，然后在Manage Collaborators里就可以管理合作者了。
  其他合作者，使用 ssh-keygen -C “[email protected]” （这里的email使用github账号）生成公钥和私钥，在Accounts Settings=》SSH keys 将公钥上传上去。

2.项目开发流程

1. 新建一个项目
   项目负责人在GitHub创建一个远程项目，建立master分支。由管理员建立说明文档，确定需要哪些文档、每个文档由哪个部门完成。然后在master分支上新建并检出develop分支，后续文档更新，包括代码提及都在develop分支上进行。

2. 关联远程项目
   由项目负责人管理开发团队权限，开发成员自行从远程克隆到本地，然后在本地进行日常工作

3. 提交文档和代码
   项目分功能模块进行同时开发，每位成员完成自己模块、文档，以及后续更新功能，自行测试后都要按照规范提交到远程。

4. 项目负责人审查合并
   开发成员的全部提交统一提交到develop分支，master分支仅由项目负责人制。项目负责人应关项目进展，对提交的代码、文档审核，不合格者及时告知。

5. 项目完成版本
   在各功能都完成开发后，由develop分支分检出release分支，测试通过后合并到master分支，完成一个版本开发。

3.部门合作开发

1. 分支概念
   
   

• master分支，即主分支。任何项目都必须有个这个分支。对项目进行tag或发布版本等操作，都必须在该分支上进行。

• develop分支，即开发分支，从master分支上检出。团队成员一般不会直接更改该分支，而是分别从该分支检出自己的feature分支，开发完成后将feature分支上的改动merge回develop分支。同时release分支由此分支检出。

• release分支，即发布分支，从develop分支上检出。该分支用作发版前的测试，可进行简单的bug修复。如果bug修复比较复杂，可merge回develop分支后由其他分支进行bug修复。此分支测试完成后，需要同时merge到master和develop分支上。

• feature分支，即功能分支，从develop分支上检出。团队成员中每个人都维护一个自己的feature分支，并进行开发工作，开发完成后将此分支merge回develop分支。此分支一般用来开发新功能或进行项目维护等。

• fix分支，即补丁分支，由develop分支检出，用作bug修复，bug修复完成需merge回develop分支，并将其删除。所以该分支属于临时性分支。

2. 项目负责人

• 创建项目
• 管理提交
• 测试迭代

2. 开发成员个人开发流程
   git支持很多种工作流程，我们采用的一般是这样，远程创建一个主分支，本地每人创建功能分支，日常工作流程如下：

    去自己的工作分支
    $ git branch work develop    # 从develop分支上新建work分支
    $ git checkout develop    # 检出work分支
   
    工作
    ....
   
    提交工作分支的修改
    $ git commit -a
   
    回到主分支
    $ git checkout develop
   
    获取远程最新的修改，此时不会产生冲突
    $ git pull
   
    回到工作分支
    $ git checkout work
   
    用rebase合并主干的修改，如果有冲突在此时解决
    $ git rebase develop
   
    回到主分支
    $ git checkout develop
   
    合并工作分支的修改，此时不会产生冲突。
    $ git merge work
   
    提交到远程主干
    $ git push origin develop
   

这样做的好处是，远程主干上的历史永远是线性的。每个人在本地分支解决冲突，不会在主干上产生冲突。

4.项目管理

1. 项目可视化管理
   项目一般情况下组织成员都有可读权限，这就意味着成员可以随时关注
   项目的最新进展，并且可以提出自己的意见，择优采纳。如此一来可以做到全员监督，集思广益，为项目的更新迭代创造更可行的方案。

2. 分支管理。
   不论是科研狗，产品狗还是攻城狮，写文档一般都有好几个版本在进行。一个比较成型但不少新想法还没加进去的给老板看的版本，不成熟的新想法版本1，不成熟的新想法版本2等等。如何在不同版本间自如切换就要用到git branch和git rebase了。用git相比于拷贝粘贴的好处体现在——有些更改是会影响到所有版本的。这时候用git的分支管理直接rebase就可以把一段更改同时应用到所有版本里。同时新想法也会逐渐并到给老板看的稳定版本里，用git也十分方便。

3. git hook=>自动化神器。
   git有个比较高阶一点的功能是git hook。大概的说就是每次执行git push的时候，客户的git会向一个远程服务器比如github发起push请求，内容是我做了这些更改有这些commits等等。服务器在接受完数据以后可以直接挂断，也可以执行一个用户指定的小程序。比如你可以（用某种方法，方法是什么下面讲）告诉服务器这个“制定的小程序”就是ls，那么服务器在你的git push执行完以后就会执行一下ls，然后把执行的结果（当前repo下面的文件列表）发给你。你的git收到以后会把这个打印在屏幕上。
   具体怎么指定这个“特定的小程序”，不同的平台不一样。如果git服务器是你自己管理的，那么可以看一下git post-receive hook (git post-receive hook)，如果是github可以看一下webhook: Creating Webhooks · GitHub Help
   这个应用非常灵活。举几个栗子：1) 我的blog (Computing Life) 是用git管理的，每次push以后会自动调用pelican生成/更新静态页面，不用自己ssh到服务器上面日了。2) 结合github的web hook可以实现代码更新邮件提醒等功能 ，这里有介绍：Automatic Email Notification on Github Pushes。 3) 代码的自动连续部署和测试，这里有介绍：Self-Updating Node.js Web App。

参考资料

• github入门
• 使用git和github进行协同开发流程
• 官方文档
• 图文详解如何利用Git+Github进行团队协作开发
• 使用git和github管理自己的项目

2018-06-10