【Git基础】开源项目管理基地Github

admin • • 研发管理

文章目录

1.Github介绍

GitHub 是一个全球最大的代码托管平台和开源社区，于 2008 年上线。它基于 Git 分布式版本控制系统，为开发者提供了一个高效、简洁、安全的代码托管、版本控制和协作的平台。总之，它是全球最大的同性交友网站。

GitHub 是一个全球最大的代码托管平台和开源社区，于 2008 年上线。它基于 Git 分布式版本控制系统，为开发者提供了一个高效、简洁、安全的代码托管、版本控制和协作的平台。

1.1 GitHub 的魅力所在

  • Repo：Repo是项目的代名词，在Github中，大量的开源项目被存储，包括由Linus Torvalds参与开发的Linux内核。在一个Repo中，用户可以提出issue，进行代码审查，创建和编辑Wiki，管理branch和tag等。此外，用户还可以给感兴趣的Repo添加star，或者fork到自己的账户下。
  • Explore：这是Github的一个功能，根据用户的兴趣推荐一些开源项目供他们探索。
  • Topics：这是Github的另一个功能，它按照项目的主题进行分类，用户可以根据自己的兴趣选择某个主题进行浏览。
  • Trending：这是Github上的一个特性，它显示的是当前流行的Repo。用户可以根据不同的编程语言和时间周期进行筛选。
  • Events：这是显示Github官方活动的一个区域，用户可以在这里了解到Github的最新动态和官方活动。

1.2 在 GitHub 上搜索高质量的开源项目

  1. 使用搜索栏：GitHub 的搜索功能非常强大。你可以在搜索栏输入你感兴趣的主题或技术，然后在结果页筛选 “Repositories”，可以查看相关的项目。

  2. 查看 Trending 页面：GitHub 的 Trending 页面展示了最近期间内受到关注的项目。这是发现新的、有趣的、高质量的项目的好地方。

  3. 关注知名组织和开发者：许多知名的技术公司和组织（如 Google，Facebook，Microsoft，Apache 等）都在 GitHub 上有自己的账号，并且会发布他们的开源项目。关注他们，可以及时了解到最新的开源项目。

  4. 查看项目的 Star、Fork 和 Issue 数量：一个项目的 Star 和 Fork 数量可以一定程度上反映其受欢迎程度和活跃程度，而 Issue 的数量和处理情况则可以反映项目维护的活跃度和社区的活跃度。

  5. 阅读项目的 README 和文档：一个优秀的项目通常会有详细的 README 和文档，介绍项目的目的，如何使用，如何贡献等。这可以帮助你更好地理解和评价一个项目。

  6. 查看项目的贡献者和 Commit：项目的贡献者数量和 Commit 频率可以反映一个项目的活跃度和健康度。如果一个项目长时间没有新的 Commit，或者只有一个或两个贡献者，那么这可能是一个风险。

  7. 尝试使用和贡献：最好的评价一个项目的方法是尝试使用它，并向项目做出贡献。通过实践，你可以了解项目的优点和缺点，以及是否适合你的需求。

2. 加入Github

2.1 注册Github账号

  1. 打开 GitHub 的主页：https://github.com

  2. 点击页面右上角的 “Sign up” 按钮。

  3. 在注册页面，输入你的用户名，电子邮件地址，以及密码。注意，用户名在 GitHub 上是唯一的，不能与其他人的用户名相同。密码应该足够复杂，以保护你的账号安全。

    • Username: 你的用户名，注意这个用户名在GitHub上必须是唯一的。
    • Email: 输入你的电子邮件地址。
    • Password: 输入你的密码，注意密码需要包含大写字母、小写字母、数字。

  4. 完成 “Verify your account” 部分。这通常涉及到一项简单的挑战，以证明你不是机器人。

  5. 选择一个账号计划。如果你只是想使用 GitHub 来托管你的代码，那么你可以选择免费的计划。如果你需要更多的功能（例如，私有仓库，高级的代码审查工具等），你可以选择付费的计划。

  6. 选择你的个人设置。这一步是可选的，你可以选择跳过。

  7. 点击 “Create account” 按钮。

完成上述步骤后，GitHub 会发送一封确认邮件到你提供的电子邮件地址。你需要点击邮件中的链接来确认你的电子邮件地址，然后你的 GitHub 账号就创建成功了。

有了 GitHub 账号，你就可以开始创建你的项目，或者参与其他人的项目了。希望你们在 GitHub 的旅程中有所收获！

2.2 添加ssh key

第一步：在本地生成 SSH Key

  1. 打开你的终端。

  2. 输入以下命令，然后按回车键。这将创建一个新的 ssh key，使用你的邮箱作为标签。

    ssh-keygen -t ed25519 -C "[email protected]"

    注意：如果你的系统不支持 ed25519，你可以使用 rsa 替换 ed25519。

  3. 当你看到 “Enter a file in which to save the key” 的提示时，直接按回车键。这将接受默认文件位置。

  4. 在提示输入 passphrase（如果需要）时，输入你的密码。

这样，你就在 “~/.ssh/” 目录下生成了 id_ed25519 和 id_ed25519.pub 两个文件，分别是你的私钥和公钥。

第二步：将 SSH Key 添加到 ssh-agent

  1. 启动 ssh-agent 后台进程： 
    eval "$(ssh-agent -s)"
  2. 将你的 SSH 私钥添加到 ssh-agent。如果你使用的是其他名称的 SSH 私钥，将命令中的 id_ed25519 替换为你的私钥文件名： 
    ssh-add ~/.ssh/id_ed25519

第三步：在 GitHub 上添加你的 SSH Key

  1. 在终端里面输入下面的命令，然后回车。这会复制你的公钥到剪切板：

    clip < ~/.ssh/id_ed25519.pub

    对于 macOS 可以使用 pbcopy < ~/.ssh/id_ed25519.pub，对于 Linux 可以使用 xclip -sel clip < ~/.ssh/id_ed25519.pub。

  2. 打开 GitHub 网站，点击你的头像，然后点击 “Settings”。

  3. 在左侧边栏点击 “SSH and GPG keys”。

  4. 点击 “New SSH key” 或 “Add SSH key”。

  5. 在 “Title” 区域中，添加一个描述，例如 “My PC”。

  6. 在 “Key” 区域中，粘贴你的公钥。

  7. 点击 “Add SSH key”。

这样，就成功地在 GitHub 上添加了 SSH Key。这将允许你的计算机通过 SSH 协议与 GitHub 通信，这种通信方式更为安全且方便。

2.3 下载开源的项目

在 GitHub 上下载开源项目有两种主要的方法：克隆（Clone）和下载 ZIP。

方法一：克隆项目

克隆是将项目的所有文件和版本历史都复制到本地的过程。你需要在本地计算机上安装 Git，然后可以使用以下步骤：

  1. 打开你想要下载的 GitHub 项目的页面。

  2. 点击页面右上角的 “Code” 按钮，然后复制 “Clone with HTTPS” 或 “Clone with SSH” 下面的链接。一般情况下，如果你已经设置了 SSH Key，推荐使用 SSH 方式。

  3. 打开你的终端，然后输入 git clone 命令，后面跟上刚才复制的链接。例如：

    git clone https://github.com/username/repo.git

    或

    git clone [email protected]:username/repo.git

  4. 按回车键，项目就会被下载到你的本地。

方法二：下载 ZIP

如果你不打算对项目做出贡献，或者你没有在本地安装 Git，那么你可以选择下载项目的 ZIP 包：

  1. 打开你想要下载的 GitHub 项目的页面。

  2. 点击页面右上角的 “Code” 按钮，然后在下拉菜单中点击 “Download ZIP”。

  3. ZIP 文件就会被下载到你的本地，你需要解压这个 ZIP 文件，才能看到项目的内容。

这就是在 GitHub 上下载开源项目的方法。在下载项目后，就可以查看项目的代码，运行项目，甚至对项目进行修改和优化了。

2.4 创建repo

在 GitHub 上创建一个新的仓库（Repository，简称 Repo）的步骤如下：

  1. 登录你的 GitHub 账号。

  2. 点击页面右上角的 “+” 图标，然后选择 “New repository”。

  3. 在 “Repository name” 字段中，输入你的仓库名。这个名字在你的账号下必须是唯一的。

  4. （可选）在 “Description” 字段中，输入一些关于你的仓库的简短描述。

  5. 选择仓库的可见性。如果你想让所有人都可以看到你的仓库，选择 “Public”。如果你只想让自己看到，选择 “Private”。

  6. （可选）如果你想在创建仓库的时候就包含一些基本的文件，你可以选择初始化设置。例如，你可以选择创建一个 README 文件，或者添加 .gitignore 文件或者添加一个许可证。

  7. 点击 “Create repository” 按钮。

完成以上步骤后，你的新仓库就创建成功了。你可以开始添加文件，写代码，或者邀请其他人参与你的项目了。

注意，一个好的仓库应该包含 README 文件，这个文件可以解释你的项目是做什么的，如何使用等等。如果你的项目使用了特殊的依赖，或者需要一些特殊的环境，你也应该在 README 文件中说明。

3. 参与开源项目的正确方式

3.1 了解开源项目

每个开源项目都伴随着一个社区的存在：

项目通常由一个社区维护，包含各种不同角色的用户，这些角色可以是正式的，也可以是非正式的：

  • 项目所有者（Owners）：这是创建项目并在其Github账户上托管项目的用户或组织。
  • 维护者和协作者（Maintainers and Collaborators）：这些是致力于项目并推动其发展的用户。通常，项目所有者和维护者是同一用户或组织，他们对仓库具有写权限。
  • 贡献者（Contributors）：任何曾向项目提交并被合并的pull request的用户都被视为贡献者。
  • 社区成员（Community Members）：这些是经常使用并且对该项目有深度关注的用户，他们在讨论功能特性和pull request方面非常活跃。

此外，项目中一般会包含以下部分：

  • README.md：README文件为项目提供了一个概览，包含了如何使用、构建，甚至如何为项目做出贡献的相关细节。例如：https://github.com/Tencent/TSW。
  • 文档和Wiki（Docs and Wiki）：项目的设计文档通常会放在项目的doc目录下，而Wiki则常用于详细介绍项目的使用、维护和贡献等信息。

3.2 了解License

在 GitHub 上，开源许可证（License）是非常重要的一部分，它规定了别人可以如何使用、修改、分发你的项目。以下是几种在 GitHub 上最常见的开源许可证，以及它们的主要使用场景：

  1. MIT License：MIT 是最常用的开源许可证之一，它允许你做任何事情，只要在分发的副本中包含原始的许可证和版权声明。如果你希望你的项目被广泛使用，并且不介意别人如何使用，那么 MIT 是一个很好的选择。

  2. Apache License 2.0：Apache License 也是一个允许很大自由的许可证，但是它比 MIT 更详细，包括如何处理版权和专利等问题。如果你的项目涉及到专利，或者你希望对使用者有更详细的规定，那么可以选择 Apache License。

  3. GNU General Public License (GPL)：GPL 是一个“病毒式”的许可证，意味着任何修改和衍生的项目都必须使用相同的许可证。如果你希望你的项目始终保持开源，那么可以选择 GPL。

  4. GNU Lesser General Public License (LGPL)：LGPL 是 GPL 的一个更灵活的版本，它允许你的项目被用于闭源的软件。如果你希望你的项目能被更广泛地使用，但是仍然希望保护你的项目不被完全闭源，那么可以选择 LGPL。

  5. BSD License：BSD 许可证和 MIT 类似，都是非常宽松的许可证。不过，BSD 许可证还有一些变种，有些变种包含了“非广告条款”（不允许使用许可证持有人的名字进行宣传）。如果你希望有更多的控制权，那么可以选择 BSD。

以上都是一些基本的许可证，实际上还有很多其他的开源许可证。选择哪种许可证取决于你希望其他人如何使用你的项目。如果你不确定应该选择哪种许可证，可以查看 choosealicense.com，这是 GitHub 提供的一个帮助你选择许可证的网站。

3.3 了解issue

在 GitHub 上，Issue 是一个非常重要的功能，它允许你跟踪项目的各种问题和建议，包括 bug 报告、功能建议、问题讨论等等。

下面是一些关于 GitHub Issue 的基本介绍：

  1. 创建和使用 Issue：任何人都可以在一个公开的仓库（Repository）中创建 Issue，只要你有一个 GitHub 账号。你可以在 Issue 中描述问题，提出建议，或者发起讨论。你也可以为 Issue 添加标签，如 “bug”、“enhancement”、“help wanted” 等等，这可以帮助其他人更好地理解和分类 Issue。

  2. 回应和管理 Issue：项目的维护者和贡献者可以回应 Issue，解答问题，或者讨论解决方案。他们也可以关闭已经解决的 Issue，或者合并重复的 Issue。此外，项目的维护者还可以使用 Milestones 和 Projects 来管理和跟踪 Issue 的进度。

  3. 从 Issue 到 Pull Request：在 GitHub 中，你可以将 Issue 转换为 Pull Request，这意味着你可以提交代码来解决 Issue 中的问题。这是一个非常常见的工作流程，特别是在开源项目中。

总的来说，GitHub 的 Issue 功能是项目管理的重要组成部分，它可以帮助你跟踪项目的进度，管理问题和建议，以及和其他人进行有效的沟通。

3.4 fork、pull request、merge request

  1. Fork：在 GitHub 上，“Fork” 是指将别人的仓库复制一份到你自己的 GitHub 账号下。这样你就可以自由地修改这个仓库，而不会影响到原始的仓库。在你 Fork 了一个仓库后，你就可以在你的版本上进行修改，添加新的代码，修复 bug 等等。

  2. Pull Request：当你在你的 Fork 的仓库上完成了修改，你可能会希望将你的修改合并回原始的仓库。这时，你就可以创建一个 “Pull Request”。Pull Request 是你向原始仓库的维护者提出请求，希望他们查看你的修改，如果他们认为你的修改是有用的，他们就会接受你的 Pull Request，将你的修改合并到原始的仓库中。Pull Request 不仅包含了你的修改，还包含了你对修改的注释，以及其他人对你修改的讨论。

  3. Merge Request：“Merge Request” 是 GitLab 中的概念，功能和 GitHub 的 “Pull Request” 非常相似。在 GitLab 中，当你希望将你的修改合并到一个分支或者一个仓库时，你可以创建一个 “Merge Request”。Merge Request 也包含了你的修改，你对修改的注释，以及其他人对你修改的讨论。

在参与开源项目时，这三个概念是非常重要的。通过 Fork 和 Pull Request，你可以参与到任何你感兴趣的开源项目中，无论你是否是这个项目的维护者。同时，通过 Pull Request 中的讨论，你还可以学习到很多新的知识，和其他开发者进行交流。

4. 如何保证团队开发质量

4.1 ZenHub

ZenHub 是一个项目管理工具，它直接集成到 GitHub 中，提供了许多功能，帮助团队更好地组织工作、跟踪进度和协作。这是一个非常适合开发团队使用的工具，因为它完全基于 GitHub，这意味着你可以直接在你熟悉的环境中使用它。

以下是 ZenHub 的一些主要功能：

  1. Issues Board：ZenHub 的 Issues Board 是一个看板，你可以在这个看板上创建、编辑和移动 GitHub Issues。这个看板类似于 Trello 或者 Jira 的看板，它按照不同的状态（如 “To Do”、“In Progress”、“Done”）组织 Issues。通过拖拽 Issues，你可以轻松地改变它们的状态。

  2. Epics：在 ZenHub 中，Epic 是一种特殊的 Issue，它可以包含其他的 Issues。这是一个很好的方式来组织大型项目，你可以将一个大任务分解为多个小任务，然后使用 Epic 来管理这些小任务。

  3. Estimates：ZenHub 允许你为每个 Issue 添加估计，这可以帮助你预测任务的完成时间。通过对比实际的完成时间和预估的完成时间，你可以更好地理解你的团队的工作效率。

  4. Reports：ZenHub 提供了许多报告，如 Burndown Chart、Velocity Tracking、Release Reports 等，帮助你跟踪项目的进度和团队的效率。

  5. Multi-repo Support：如果你的项目分布在多个仓库中，ZenHub 可以帮助你在一个地方管理所有的仓库。你可以在一个 Issues Board 中查看所有仓库的 Issues，也可以创建跨仓库的 Epics。

ZenHub 是一个付费的服务，但是对于公开的开源项目，它是免费的。如果你的团队正在使用 GitHub，那么 ZenHub 可以是一个很好的工具，帮助你更好地管理你的项目。

4.2 TravisCI

Travis CI 是一款非常流行的持续集成（Continuous Integration，简称 CI）服务，它与 GitHub 紧密集成，能够自动化执行各种构建和测试任务，提高软件开发效率和质量。

以下是 Travis CI 的主要功能和特性：

  1. 自动化构建和测试：每当你向 GitHub 仓库推送更改（例如，提交新的代码或合并 pull request），Travis CI 都会自动启动构建和测试过程。这意味着你可以立即发现新代码是否引入了错误或失败的测试。

  2. 多语言支持：Travis CI 支持多种编程语言，包括 Java、Python、Ruby、Node.js、Go、PHP 等。根据你的项目需求，Travis CI 可以自动设置合适的构建环境。

  3. 配置灵活：Travis CI 的配置存储在你的代码仓库中名为 .travis.yml 的文件里。这个文件定义了 Travis CI 应该如何构建和测试你的项目，包括环境变量、依赖安装、脚本执行等。这种方式让配置管理变得直观且易于版本控制。

  4. 并行运行：Travis CI 支持并行运行多个构建和测试任务，从而加速整个 CI 过程。对于大型项目，这个特性可以大大减少构建和测试的时间。

  5. 集成部署：Travis CI 支持自动部署到多种平台，包括 Heroku、AWS、Google Cloud、GitHub Pages 等。一旦构建和测试成功，Travis CI 就可以自动将应用部署到生产环境。

  6. 开源友好：对于开源项目，Travis CI 是完全免费的。这使得许多开源项目选择 Travis CI 作为他们的 CI 工具。

总的来说，Travis CI 是一款强大的 CI 工具，它可以帮助你自动化构建和测试过程，提高代码质量，加速软件开发周期。

4.3 Reviewable

Reviewable 是一个为 GitHub 设计的代码审查工具，它旨在使代码审查过程更加流畅和高效。这个工具集成到你的 GitHub 工作流程中，并且提供了一些强大的特性来帮助你更好地管理和执行代码审查。

以下是 Reviewable 的一些主要特性：

  1. 代码对比：Reviewable 提供了强大的代码对比工具，它可以对比任意两个版本之间的差异，包括跨越多个提交的差异。这使得代码审查者可以更容易地理解代码的变化。

  2. 讨论和评论：在 Reviewable 中，你可以对特定的代码行添加评论，这些评论会与 GitHub 同步。此外，Reviewable 还提供了一些工具来帮助你管理讨论，例如，你可以折叠或解决讨论，或者使用 @mentions 来引用其他人。

  3. 审查状态跟踪：Reviewable 可以跟踪每个审查者的审查状态，包括他们已经审查了哪些文件，以及他们是否完成了审查。这可以帮助团队更好地协作，并且确保每个改动都被审查。

  4. 集成 GitHub：Reviewable 完全集成到 GitHub 中，你不需要额外的账号，只需要使用你的 GitHub 账号就可以登录。所有的评论、审查和改动都会与 GitHub 同步，这意味着你可以在任何地方查看和管理你的代码审查。

  5. 自定义工作流：Reviewable 提供了一些配置选项，让你可以根据你的需求定制你的代码审查工作流。例如，你可以设置审查规则，定义何时需要审查，以及审查需要哪些审查者。

Reviewable 是一个付费的工具，但是对于公开的开源项目，它是免费的。如果你的团队正在使用 GitHub，并且希望改进你的代码审查工作流，那么 Reviewable 可能是一个很好的选择。

4.4 maillist

邮件列表（Mailing List）是一种经典的在线交流工具，用于将信息发送到订阅该列表的人。这种工具在许多开源项目中都得到了广泛的使用，因为它可以方便地管理大量的用户和开发者，并且可以跨越不同的时间区进行交流。

以下是关于邮件列表的一些基本信息：

  1. 订阅和取消订阅：为了收到邮件列表的邮件，你需要首先订阅邮件列表。这通常涉及到发送一封邮件到特定的地址，或者在网页上填写你的电子邮件地址。一旦你订阅了邮件列表，你就会收到所有发送到列表的邮件。如果你不再希望收到这些邮件，你可以取消订阅。

  2. 发送和接收邮件：当你想要发送邮件到列表时，你只需要将邮件发送到列表的电子邮件地址。然后，这封邮件就会自动发送到所有订阅了该列表的人。同样，当其他人发送邮件到列表时，你也会收到这些邮件。

  3. 讨论和协作：邮件列表是一种很好的讨论和协作工具。你可以通过邮件列表提问，分享你的想法，或者报告问题。其他人也可以回复你的邮件，这样就形成了一个线程，或者说是一系列的相关邮件。

  4. 公开和私有：邮件列表可以是公开的，也可以是私有的。公开的邮件列表对任何人都开放，任何人都可以订阅和发送邮件。私有的邮件列表则只对特定的人开放，通常需要管理员的批准才能订阅。

  5. 归档：许多邮件列表都提供了归档功能，这意味着所有的邮件都会被保存在一个可搜索的数据库中。这使得你可以查找旧的邮件，或者阅读你在订阅列表之前的讨论。

邮件列表是一种很重要的在线交流工具，尤其是在开源社区中。它们可能没有像 Slack 或者 Discord 这样的即时聊天工具那么现代，但是它们的广泛可用性和简单性使得它们在许多情况下仍然是最佳的选择。

本图文内容来源于网友网络收集整理提供，作为学习参考使用，版权属于原作者。
THE END
分享
二维码

)">
< <上一篇
下一篇>>