探索 GitHub 工作流程

已完成

GitHub 是启用项目中协作的最佳工具。 GitHub flow 是一种建议在 GitHub 上使用的基于分支的工作流程。

备注

若要实现 GitHub 流,需要一个 GitHub 帐户和一个存储库。 请参阅“注册 GitHub”和“创建存储库”。

提示

可以通过 GitHub Web 界面、命令行、 GitHub CLIGitHub Desktop 完成 GitHub 流的所有步骤。

第一步是在存储库中创建一个分支,在不影响默认分支的情况下工作,并让协作者有机会查看工作。

有关详细信息,请参阅“在存储库中创建和删除分支”。

表示分支创建的分支模型的屏幕截图。

对存储库进行任何所需的更改。 如果犯了错误,可以还原更改或推送其他更改以修复错误。

提交更改并将其推送到分支,以将工作备份到远程存储,为每个提交提供描述性消息。 每次提交都应包含一个独立且完整的更改,以便在采用不同方法时可以轻松恢复。

与项目协作的任何人都可以查看你的工作、回答问题,并提出建议或贡献。 继续在你的分支上创建、提交并推送更改,直到你准备好请求反馈。

提示

你可以为每个更改创建单独的分支,以便审阅者能够轻松提供反馈或了解差异。

准备就绪后,可以创建拉取请求,要求协作者提供有关更改的反馈。 请参阅“创建拉取请求”。

拉取请求审阅是协作中最有价值的功能之一。 合并更改之前,可以要求同行和团队批准。 此外,在完成更改之前,你可以将其标记为草稿,以防你希望提前获取反馈或建议。

表示打开拉取请求的分支模型的屏幕截图。

尽可能详细描述拉取请求,包括建议的更改以及要解决的问题。 可以添加图像、链接、相关问题或任何信息来记录更改,并帮助审阅者在不打开每个文件的情况下了解 PR。 请参阅“基本写入和格式设置语法”和“将拉取请求链接到问题”。

打开拉取请求的屏幕截图,其中包含说明字段、相关问题和清单模板。

提高 PR 质量和文档的另一种方法是使用评论区,以明确指出需要审阅者注意的内容。 你也可以 @mention 或要求特定的人员或团队进行审阅。

拉取请求评论字段的屏幕截图。

还有其他拉取请求配置,例如在创建拉取请求后自动要求特定团队或用户进行审阅,或对拉取请求运行检查。 有关详细信息,请参阅“关于状态检查”和“关于受保护的分支”。

审阅者完成注释和检查验证后,应随时可合并更改,他们可以批准拉取请求。 请参阅合并拉取请求

如果存在任何冲突,GitHub 会通知你解决这些问题。 “解决合并冲突。”

表示分支合并的分支模型的屏幕截图。

成功合并拉取请求后,无需保留远程分支。 可以删除分支以防止其他人意外使用旧分支。 有关详细信息,请参阅“删除和还原拉取请求中的分支”。

备注

GitHub 会保留提交和合并历史记录,以便您需要时恢复或回退拉取请求。