欢迎光临散文网 会员登陆 & 注册

GitHub flow

2022-04-07 11:31 作者:iostreamreader  | 我要投稿

介绍

GitHub 流是一个轻量级的、基于分支的工作流。GitHub 流对每个人都很有用,而不仅仅是开发人员。例如,在 GitHub,我们使用 GitHub 流程作为站点策略、文档和路线图。

先决条件

若要遵循 GitHub 流,你需要一个 GitHub 帐户和一个存储库。有关如何创建帐户的信息,请参阅"注册 GitHub"。有关如何创建存储库的信息,请参阅"创建存储库"。有关如何查找要参与的现有存储库的信息,请参阅"在 GitHub 上查找为开源做出贡献的方法"。

遵循 GitHub 流

提示:您可以通过 GitHub Web 界面、命令行和 GitHub CLI 或 GitHub Desktop 完成 GitHub 流的所有步骤。

创建分支

在存储库中创建分支。简短的描述性分支名称使您的协作者能够一目了然地查看正在进行的工作。例如,或 .更多信息请参阅"在存储库中创建和删除分支"。increase-test-timeoutadd-code-of-conduct

通过创建分支,可以创建一个空间,以便在不影响默认分支的情况下工作。此外,您还可以让协作者有机会查看您的工作。

进行更改

在分支上,对存储库进行任何所需的更改。有关更多信息,请参阅"创建新文件"、"编辑文件"、"重命名文件"、"将文件移动到新位置"或"删除存储库中的文件"。

您的分支机构是进行更改的安全场所。如果您犯了错误,可以还原更改或推送其他更改来修复错误。在合并分支之前,您的更改不会最终出现在默认分支上。

提交更改并将其推送到分支。为每个提交提供一条描述性消息,以帮助你和未来的参与者了解提交包含哪些更改。例如,或 .fix typoincrease rate limit

理想情况下,每个提交都包含一个隔离的完整更改。这样,如果您决定采用不同的方法,可以轻松还原更改。例如,如果要重命名变量并添加一些测试,请将变量重命名放在一个提交中,将测试放在另一个提交中。稍后,如果要保留测试但还原变量重命名,则可以还原包含变量重命名的特定提交。如果将变量重命名和测试放在同一个提交中,或者将变量重命名分散到多个提交中,则还原更改将花费更多精力。

通过提交和推送更改,您可以将工作备份到远程存储。这意味着您可以从任何设备访问您的作品。这也意味着您的协作者可以看到您的工作,回答问题并提出建议或贡献。

继续进行更改、提交更改并将其推送到分支,直到准备好请求反馈。

提示:为每组不相关的更改创建一个单独的分支。这使得审阅者更容易提供反馈。它还使您和未来的协作者更容易理解更改并还原或构建它们。此外,如果一组更改中存在延迟,则其他更改也不会延迟。

创建拉取请求

创建拉取请求,向协作者询问有关您更改的反馈。拉取请求审核非常有价值,以至于某些存储库需要经过审批审核才能合并拉取请求。如果您在完成更改之前需要早期反馈或建议,则可以将拉取请求标记为草稿。更多信息请参阅"创建拉取请求"。

创建拉取请求时,请包括更改的摘要以及它们解决的问题。您可以包括图像、链接和表格来帮助传达此信息。如果拉取请求解决了某个问题,请链接该问题,以便问题利益干系人了解拉取请求,反之亦然。如果使用关键字进行链接,则在拉取请求合并时,问题将自动关闭。更多信息请参阅"基本编写和格式设置语法"和"将拉取请求链接到问题"。

除了填写拉取请求的正文外,您还可以向拉取请求的特定行添加注释,以向审阅者明确指出某些内容。

您的存储库可以配置为在创建拉取请求时自动请求特定团队或用户的审阅。您还可以手动@mention或请求特定人员或团队进行审核。

如果您的存储库已将检查配置为在拉取请求上运行,您将看到在拉取请求上失败的所有检查。这有助于您在合并分支之前捕获错误。更多信息请参阅"关于状态检查"。

解决审核意见

审稿人应留下问题、意见和建议。审阅者可以对整个拉取请求进行注释,也可以向特定行添加注释。您和审阅者可以插入图像或代码建议来阐明注释。更多信息请参阅"查看拉取请求中的更改"。

您可以继续提交和推送更改以响应评论。您的拉取请求将自动更新。

合并您的拉取请求

拉取请求获得批准后,合并拉取请求。这将自动合并您的分支,以便您的更改显示在默认分支上。GitHub 在拉取请求中保留注释和提交的历史记录,以帮助将来的贡献者了解您的更改。更多信息请参阅"合并拉取请求"。

GitHub 会告诉您拉取请求是否存在冲突,必须在合并之前解决这些冲突。更多信息请参阅"解决合并冲突"。

如果拉取请求不满足某些要求,则分支保护设置可能会阻止合并。例如,您需要一定数量的审批审核或来自特定团队的审核审核。更多信息请参阅"关于受保护的分支"。

删除您的分支

合并拉取请求后,删除分支。这表示分支上的工作已完成,并防止您或其他人意外使用旧分支。更多信息请参阅"删除和还原拉取请求中的分支"。

不用担心丢失信息。您的拉取请求和提交历史记录不会被删除。如果需要,您始终可以还原已删除的分支或还原拉取请求。

原文网址

https://docs.github.com/cn/get-started/quickstart/github-flow

GitHub flow的评论 (共 条)

分享到微博请遵守国家法律