开发大佬的 Github 分享

今天是组内第一次组织分享会,分享的内容主要有两部分,第一部分是设备端大佬的性能速度优化,第二部分是系统组大佬的 Github 使用分享。这里主要记录一下 Github 的使用分享。也很遗憾以后没能听到组内这些大佬们的分享了。

功能介绍

这部分主要介绍了下面这四个部分的使用:

  • Issues :这部分主要是他人提的 bug 和要求之类的
  • Pull Request:代码合并的路径,在协作开发中很重要。这部分也可以作为一个相互学习的空间,开发者 B 要合并代码进 Repo 发起一个 Pull Request ,此时可能会提供一个 check list ,Repo 原创者就可以依据 check list 来 review 开发者 B 的代码。如果代码中有错误或者可以优化的部分,可以直接在代码中评论。
  • Projects:这部分是自己建立的项目,对外可以展示项目的进度,对内可以自己制作 to do list。
  • Insights:这部分主要展示的自己 Github 的数据。可以查看活跃度,网友查看来源等等。对于最大的同性交友平台来说,这部分数据很贴心了 :)

一个好项目的 README

一个好的项目的 README 往往会包含以下几部分的说明:

  • Start
  • Install
  • Build
  • Documentation
  • License :这个很重要,可以告诉他人要怎样遵从要求。

Bug 管理

在 Github 中可以自己设置很多的 labels ,然后用其对 Issues 进行标注分类,可以在 Projects 中建一个 Bug 管理的项目,然后建立 To do,In progress,Done这三个标签对 bug 进行分类。

你可能感兴趣的:(开发大佬的 Github 分享)