Skip to main content

2 posts tagged with "Change Request"

View All Tags

· 5 min read
Kyle

Git 与 AtomGit 实践：维护者审核与合并变更请求​

本教程旨在指导维护者如何有效地审核和合并变更请求，以确保项目的质量和一致性。

1. 审核Change Request​

维护者收到Change Request后，应执行以下步骤：

  1. 查看变更内容：

  2. 提出反馈或建议：

    • 如果发现问题或有改进建议，可以在Change Request页面留言，要求贡献者进行相应修改。

  3. 确认无误后批准：

    • 如果变更符合要求，点击"通过"/“不通过”按钮，确认Change Request。

2. 合并Change Request​

审核通过后，维护者可以将贡献者的变更合并到上游仓库：

  1. 点击"合并"按钮：

    • 在Change Request页面，点击页面右上角的"合并"按钮。

  2. 选择合并方式：

    • 通常选择"创建合并提交"方式进行合并，确保所有变更记录完整保留。

  3. 确认合并信息：

    • 检查合并信息无误后，点击确认完成操作。

3. 同步上游仓库更新​

所有贡献者应定期同步上游仓库的最新更改，以保持与自己fork的仓库的同步。在终端/PowerShell中执行以下步骤： 以下内容是在你电脑的 my_open_source_contributions 仓库目录下执行。

  1. 添加上游仓库：

    git remote add upstream git@atomgit.com:atomgit_operate/my_open_source_contributions.git

  2. 获取上游仓库的更新：

    git fetch upstream/master

  3. 切换到主分支并合并：

    git checkout master
    git merge upstream/master

  4. 推送更新到Fork仓库：

    git push origin master

  5. 再次提交变更请求：

    • 重复提交变更请求的步骤，确保所有更改都被正确记录和审核。

4. 最佳实践​

  • 定期同步：保持本地仓库与上游仓库的同步，减少冲突发生。
  • 详细提交信息：每次提交都应有清晰、详细的说明，便于他人理解更改内容。
  • 内容审核：维护者应进行严格的内容审核，确保提交的质量。
  • 选择审核人：提交Change Request时，选择审核人（reviewers）来审核您的变更。
  • 书写清晰的PR描述：在提交Change Request时，提供详细的描述，说明更改的原因和内容，便于审核人员理解。

通过遵循这些步骤和最佳实践，维护者可以有效地管理和合并变更请求，确保项目的持续健康发展。

推荐阅读​

如果你对本文内容感兴趣，或者希望了解更多相关知识，以下是一些推荐阅读的文章：

  1. Git 与 AtomGit 实践：从零到一，单用户操作单仓库

    • 详细介绍了如何从零开始使用 Git 和 AtomGit 进行单用户操作单仓库的完整流程，包括环境配置、创建仓库、提交更改等步骤。

  2. Git 与 AtomGit 实践：向上游仓库贡献内容

    • 详细介绍了如何向上游仓库贡献内容的完整流程，包括Fork、克隆、提交更改和提交变更请求等步骤。

通过阅读这些文章，你将能够更全面地了解如何使用 Git 和 AtomGit 进行开源项目的贡献和管理。希望这些资源对你有所帮助！

· 8 min read
Kyle

Git 与 AtomGit 实践：向上游仓库贡献内容​

主要介绍了如何向上游仓库或其他开源项目贡献内容，以参与开源社区建设。

我们将以 my_open_source_contributions 作为上游仓库，如何向此仓库贡献内容为例，介绍如何参与开源项目。

1、账号准备与环境检查​

提示：为确保顺利完成本练习，在操作前请先完整阅读 《Git 与 AtomGit 实践：从零到一，单用户操作单仓库》，熟悉基本概念和操作后再继续。

1）注册 AtomGit 账号

2）验证手机号和邮箱

3）Git 环境配置

2. Fork（分叉/复制）上游仓库​

贡献者在开始贡献前，需要先将上游仓库Fork到自己的AtomGit账号下：

  1. 打开您的浏览器，访问上游仓库页面：https://atomgit.com/atomgit_operate/my_open_source_contributions。
  2. 在仓库页面的右上角，点击"Fork"按钮，将仓库Fork到您的账户中。

3. 克隆Fork后的仓库​

在本地机器上，请按照您的操作系统选择相应步骤操作，请将您的用户名替换为您的AtomGit用户名。

Windows 用户：​

  1. 打开PowerShell：

    • 点击"开始"菜单，输入"PowerShell"
    • 点击"Windows PowerShell"以打开它

  2. 执行克隆命令：

    • 在PowerShell窗口中，输入以下命令并按回车执行：
      git clone git@atomgit.com:您的用户名/my_open_source_contributions.git

  3. 进入仓库目录：

    cd my_open_source_contributions

  4. 打开项目目录：

    start .

macOS 用户：​

  1. 打开终端：

    • 使用 Spotlight（Command + 空格）搜索"Terminal"
    • 点击"Terminal"应用打开

  2. 执行克隆命令：

    git clone git@atomgit.com:您的用户名/my_open_source_contributions.git

  3. 进入仓库目录：

    cd my_open_source_contributions

  4. 打开项目目录：

    open .

Linux 用户：​

  1. 打开终端：

    • 使用快捷键 Ctrl + Alt + T
    • 或从应用程序菜单中打开终端

  2. 执行克隆命令：

    git clone git@atomgit.com:您的用户名/my_open_source_contributions.git

  3. 进入仓库目录：

    cd my_open_source_contributions

  4. 打开项目目录：

    • 使用您的习惯编辑器或文件管理器打开当前目录：

4. 增删改文件并提交更改​

  1. 创建和编辑文件：

    • 在项目目录中，使用任意文本编辑器（如VS Code、Sublime Text、记事本等）
    • 创建一个新文件，您可以自由选择文件名和类型，例如：
      • my_story.txt
      • project_ideas.md
      • notes.py
      • config.json
      • data.yaml
    • 在新文件中添加任意内容，比如：
      这是我开源贡献的历程
      让我们一起开源贡献
    • 编辑完成后保存更改

  2. 提交更改：

5. 推送到Fork仓库​

将本地的更改推送到自己Fork的仓库：

在终端/PowerShell中执行：

git push origin master

6. 提交变更请求（Change Request）​

  1. 登录AtomGit：

    • 打开您的浏览器，访问AtomGit并登录您的账户。

  2. 导航至Fork的仓库：

  3. 提交Change Request：

    • 点击仓库页面左侧菜单中的"变更请求"菜单。在"新建变更请求"页面，确保"来源"选择为您的账户下的Fork仓库的master分支。默认已经正确选择。目的分支选择为"上游仓库的master分支"。
    • 填写Change Request的标题和描述，确保清晰说明所做的更改。例如：
      • 标题：添加新功能和开源寄语
      • 描述：本次提交包括添加“xxx”文件以及在main.txt中添加我的开源寄语，旨在丰富项目内容并表达对开源的支持。
      • 审核人：选择审核人（reviewers）来审核您的变更。

  4. 提交并等待审核：

    • 点击"确定"按钮，完成变更请求的创建，等待维护者的审核。

注意：作为贡献者角色，到此完成了向上游仓库贡献内容。

7. 最佳实践​

  • 定期同步：保持本地仓库与上游仓库的同步，减少冲突发生。
  • 详细提交信息：每次提交都应有清晰、详细的说明，便于他人理解更改内容。
  • 内容审核：维护者应进行严格的内容审核，确保提交的质量。
  • 选择审核人：提交Change Request时，选择审核人（reviewers）来审核您的变更。
  • 书写清晰的Change Request描述：在提交Change Request时，提供详细的描述，说明更改的原因和内容，便于审核人员理解。

推荐阅读​

如果你对本文内容感兴趣，或者希望了解更多相关知识，以下是一些推荐阅读的文章：

  1. Git 与 AtomGit 实践：从零到一，单用户操作单仓库

    • 详细介绍了如何从零开始使用 Git 和 AtomGit 进行单用户操作单仓库的完整流程，包括环境配置、创建仓库、提交更改等步骤。

  2. Git 与 AtomGit 实践：维护者审核与合并变更请求

    • 介绍了维护者如何审核和合并变更请求的流程，确保项目的质量和一致性。

通过阅读这些文章，你将能够更全面地了解如何使用 Git 和 AtomGit 进行开源项目的贡献和管理。希望这些资源对你有所帮助！