GitHub 流程

按照 GitHub 流程开展项目协作。

本文内容

简介

GitHub 流程是一个基于分支的轻量级工作流程。 GitHub 流程对每个人都有用,而不仅仅是开发者。 例如,在 GitHub 中,我们使用 GitHub 流程处理我们的站点政策文档路线图

基本要求

要遵循 GitHub 流程,您将需要 GitHub 帐户和仓库。 有关如何创建帐户的信息,请参阅“注册 GitHub”。 有关如何创建仓库的信息,请参阅“创建仓库”。

遵循 GitHub 流程

提示: 您可以通过 GitHub web 界面或者命令行和 GitHub CLI 完成 GitHub 流程。

创建分支

在仓库中创建分支。 简短的描述性分支名称使您的合作者能够一目了然地看到正在进行的工作。 例如 increase-test-timeoutadd-code-of-conduct。 更多信息请参阅“创建和删除仓库中的分支”。

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

进行更改

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

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

提交并将您的更改推送到您的分支。 给每个提交一个描述性的信息来帮助您和未来的贡献者理解提交的内容包含哪些更改。 例如,修复拼写错误增加速率限制

理想情况下,每个提交都包含一个孤立的、完整的更改。 这样,如果您决定采取不同的方法,就很容易恢复您的更改。 例如,如果您要重命名变量并添加一些测试,则将变量重命名放在一个提交中,将测试放在另一个提交中。 以后,如果您想保留测试但恢复变量重命名,则可以恢复包含变量重命名的特定提交。 如果您将变量重命名和测试放在相同的提交中,或将变量重命名扩展到多个提交中,您将花费更多精力恢复更改。

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

继续对分支进行更改、提交和推送更改,直到您准备好征求反馈。

提示:为每组互不相关的更改单独创建一个分支。 这使得评论者更容易提供反馈。 这也使你和未来的协作者更容易理解这些改变,以及恢复这些改变或在其基础上构建。 此外,如果一组更改出现延迟,您的其他更改不会延迟。

创建拉取请求

创建拉取请求,要求协作者对您的更改进行反馈。 拉取请求审查非常重要,以至于某些仓库需要批准审查才能合并拉取请求。 如果您在完成更改之前需要早期反馈或建议,您可以将您的拉取请求标记为草稿。 更多信息请参阅“创建拉取请求”。

创建拉取请求时,包括更改的摘要以及它们解决的问题。 您可以包含图片、链接和表格来帮助传达此信息。 如果您的拉取请求说明了某个议题,请链接该议题,以便议题利益相关者了解拉取请求,反之亦然。 如果您链接关键字,当拉取请求合并时,议题将自动关闭。 更多信息请参阅“基本编写和格式语法”和“将拉取请求链接到议题”。

拉取请求正文

除了填写拉取请求的正文, 您可以在拉取请求的特定行中添加评论,向审核者明确指出一些内容。

拉取请求评论

创建拉取请求时,您的仓库可能会被配置为自动请求特定团队或用户的审查。 您也可以手动@提及或要求特定的人或团队进行审查。

如果您的仓库有配置为在拉取请求上运行的检查,则您将看到任何在拉取请求上失败的检查。 这有助于您在合并您的分支之前发现错误。 更多信息请参阅“关于状态检查”。

解决审查评论

评论者应留下问题、评论和建议。 评论者可以评论整个拉取请求或将评论添加到特定行。 您和评论者可以插入图像或代码建议来澄清评论。 更多信息请参阅“审查拉取请求中的更改”。

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

合并拉取请求

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

GitHub 会告知您的拉取请求是否有必须在合并前解决的冲突。 更多信息请参阅“解决合并冲突”。

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

删除分支

合并拉取请求后,删除您的分支。 这表明分支的工作已经完成,可防止您或其他人意外使用旧分支。 更多信息请参阅“删除和恢复拉取请求中的分支”。

不要担心丢失信息。 您的拉取请求和提交历史记录不会被删除。 如有必要,您可以随时恢复已删除的分支或恢复拉取请求。

此文档对您有帮助吗?隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。