GitHub 指南：协作和项目管理

GitHub 已成为软件开发人员和项目经理等的重要平台。它将强大的版本控制与社交编码功能相结合，使团队协作无缝。无论您是为开源项目做出贡献还是管理私人团队存储库，GitHub 都可以提供您跟踪更改、审查代码和自动化工作流程所需的工具。本指南介绍了从帐户设置到高级项目管理的所有内容。

介绍

GitHub 的核心是 Git 存储库的托管平台。它在 Git 版本控制系统之上添加了基于 Web 的界面、问题跟踪、代码审查工具和 CI/CD 功能。了解一些关键概念将有助于您入门：

• 存储库：项目的中央容器 - 它保存所有文件、文件夹、文档和完整的修订历史记录。
• 提交：对存储库所做更改的快照，并附有说明更改内容和原因的描述性消息。
• 分支：独立的开发线。分支让您可以在不影响主代码库的情况下处理功能或修复错误。
• 拉取请求 (PR)：将一个分支的更改合并到另一个分支的提议。 PR 是代码审查和讨论的主要机制。
• 问题：代表任务、错误报告、功能请求或项目中任何可操作项目的跟踪项目。

第 1 步：创建 GitHub 帐户

在使用 GitHub 之前，您需要一个帐户。注册过程很简单：

1. 导航至 github.com。
2. 单击右上角的 注册 按钮。
3. 输入用户名、您的电子邮件地址和强密码。
4. 通过检查发送到您收件箱的确认电子邮件来验证您的帐户。
5. 单击电子邮件中的验证链接以激活您的帐户。

验证后，您可以立即开始创建存储库并与其他人协作。为了增强安全性，请考虑从您的帐户设置启用双因素身份验证 (2FA)。

第 2 步：创建存储库

GitHub 上的每个项目都以存储库开始。创建一个：

1. 单击任意 GitHub 页面右上角的 ++ 图标，然后选择 新建存储库。
2. 填写存储库详细信息：
   • 存储库名称：选择一个简短的描述性名称。
   • 描述：项目目的的可选摘要。
   • 可见性：选择公开（所有人可见）或私人（仅限您和受邀协作者）。
3. （可选）检查 使用自述文件初始化此存储库 以从一开始就添加文档文件。
4. 单击创建存储库。

您的新存储库现已准备就绪。您可以使用 Git 从本地计算机推送代码，或直接通过浏览器界面上传文件。

第 3 步：上传文件并进行提交

将文件添加到存储库并记录更改是通过提交完成的：

1. 在您的存储库中，单击 添加文件 并选择上传文件或创建新文件。
2. 进行更改后，编写一条提交消息，清楚地描述您所做的事情。好的提交消息简洁而信息丰富。
3. 单击“提交更改”以记录快照。

每次提交都会成为项目历史记录的永久组成部分，从而可以跟踪谁更改了什么以及何时更改。此审计跟踪对于调试和了解项目的演变非常宝贵。

第 4 步：使用分支和拉取请求

分支使您的工作保持隔离，直到准备好合并为止。这是典型的工作流程：

1. 单击分支选择器（默认情况下标记为 main）并输入新分支的名称。常见的命名约定包括 feature/add-login 或 bugfix/issue-42。
2. 在此分支上进行更改并提交。
3. 打开从您的分支到主分支的拉取请求。 PR 表单可让您描述您的更改、链接相关问题并请求特定的审阅者。
4. 团队成员可以对差异发表评论、提出更改建议以及批准或请求修订。
5. 一旦获得批准，合并拉取请求以将您的更改合并到主分支中。

拉取请求清单

第 5 步：跟踪问题

Issues 是 GitHub 的内置项目管理工具。它们帮助您组织任务、报告错误和规划功能：

1. 转到存储库中的 ​​Issues* 选项卡。
2. 单击 新问题 并为其指定描述性标题和详细正文。
3. 使用标签（例如 bug、enhancement、help wanted）、受让人、里程碑和项目板链接来增强问题。
4. 使用 markdown 来格式化描述、添加清单并使用 #issue-number 引用相关问题或拉取请求。

问题还可以直接链接到拉取请求，在合并 PR 时自动关闭它们（例如，PR 描述中的“关闭 #42”）。

第 6 步：通过 Pull Request 进行代码审查

代码审查是 GitHub 最强大的功能之一。它鼓励协作并在问题进入生产之前发现问题：

1. 在 拉取请求 选项卡中，单击 新拉取请求 并选择要比较的分支。
2. 写下清晰的标题和描述，解释更改背后的动机。
3. 请求特定的审阅者，他们将被通知检查您的代码。
4. 审阅者可以在特定行上添加内嵌注释、批准 PR 或请求更改。
5. 在处理所有反馈并获得审阅者批准后，可以合并 PR。

彻底的代码审查过程可以提高代码质量，在整个团队中传播知识，并减少引入错误的可能性。

第 7 步：使用 GitHub Actions 实现自动化

GitHub Actions 可以直接在您的存储库中启用 CI/CD。工作流程在存储在 .github/workflows 目录中的 YAML 文件中定义。以下是在每次推送时运行测试的示例工作流程：

name: CI
on: [push]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm ci
      - run: npm test

开始使用：

1. 单击存储库中的 ​​操作* 选项卡。
2. 选择模板工作流程或从头开始创建一个。
3. 提交工作流程文件并观察 GitHub 在每次推送时自动运行它。

操作还可以部署到云服务、发布包、发送通知等等。

第 8 步：协作和项目管理

GitHub 提供了多种用于管理团队工作流程的功能：

• 项目：用于跨存储库跟踪任务的看板式板。您可以将问题和 PR 组织到“待办事项”、“进行中”和“已完成”等列中。
• Wiki：每个存储库的内置文档空间。
• 讨论：类似论坛的空间，用于团队对话、问答和社区参与。
• 团队和权限：通过精细的访问控制将协作者组织成团队。

导航到 设置 > 管理访问权限 以邀请协作者并设置从只读到管理员的权限级别。

第 9 步：搜索和发现

GitHub 也是一个庞大的开源项目网络。使用任何页面顶部的搜索栏可以：

• 按名称、语言或主题查找存储库。
• 使用高级限定符在公共存储库中搜索代码。
• 在探索页面上发现热门项目。
• 分叉有趣的项目并通过拉取请求贡献改进。

第 10 步：安全最佳实践

保护您的代码和帐户至关重要。请遵循以下安全实践：

1. 为您的帐户启用双因素身份验证 (2FA)。
2. 使用私有存储库来存储专有代码，并仅向受信任的协作者授予访问权限。
3. 启用 Dependabot 警报以接收有关易受攻击的依赖项的通知。
4. 使用 GitHub 的内置安全工具运行代码扫描或集成第三方扫描仪。
5. 查看存储库安全选项卡中的安全建议。

结论

GitHub 不仅仅是一个 Git 托管服务，它还是一个用于软件开发和团队协作的完整平台。通过掌握存储库、分支、拉取请求、问题、操作和安全功能，您可以显着改进您的开发工作流程。从小处开始，定期练习，并探索广泛的 GitHub 文档 以释放平台的全部潜力。