浏览 GitHub 流

已完成

GitHub 是在项目中实现协作的最佳工具。 GitHub 流是针对 GitHub 建议的基于分支的工作流。

注意

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

提示

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

第一步是在存储库中创建一个分支,在不影响默认分支的情况下工作,你为协作者提供了审阅工作的机会。

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

Screenshot of a branching model representing the branch creation.

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

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

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

提示

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

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

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

Screenshot of a branching model representing an open a pull request.

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

Screenshot of open a pull request representation with description field, related issue and a checklist template.

另一种提高拉取请求质量、完善文档并向审阅者明确指出一些内容的方法是使用注释会话区域。 你也可以 @mention 或要求特定的人员或团队进行审阅。

Screenshot of pull request comment field.

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

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

如果你遇到了任何冲突,GitHub 会通知你解决这些冲突。 “解决合并冲突”。

Screenshot of a branching model representing the branch merge.

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

注意

如果你需要恢复或还原拉取请求,GitHub 将保留提交和合并历史记录。