Skip to main content

在 GitHub 上通信

您可以在 GitHub Enterprise Cloud 中使用不同类型的讨论来讨论特定项目和更改,以及更广泛的想法或团队目标。

简介

GitHub Enterprise Cloud 提供内置的协作通信工具,使您能够与社区进行密切互动。 此快速入门指南将指导您如何根据您的需求选择合适的工具。

可以根据想参加的对话类型创建并参与问题、拉去请求和 GitHub Discussions。

GitHub Issues

  • 适用于讨论项目的具体细节,如漏洞报告、计划的改进和反馈。
  • 是特定于存储库的,通常有一个明确的所有者。
  • 通常被称为 GitHub 的错误跟踪系统。

拉取请求

  • 允许您提出具体的更改。
  • 允许您直接评论其他人建议的更改。
  • 是特定于仓库的。

GitHub Discussions

  • 就像一个论坛,最好用来进行合作很重要的开放式想法和讨论。
  • 可能跨越许多仓库。
  • 在代码库之外提供协作体验,从而集思广益,并创建社区知识库。
  • 往往没有明确的所有者。
  • 通常不会导致可操作的任务。

我应该使用哪种讨论工具?

议题场景

  • 我想跟踪任务、增强功能和漏洞。
  • 我想提交错误报告。
  • 我想分享有关特定功能的反馈。
  • 我想询问有关仓库文件的问题。

问题示例

此示例说明了 GitHub 用户如何在我们的文档开源仓库中创建议题,以便让我们了解错误并讨论修复方法。

问题的屏幕截图,标题为“通知中的蓝色链接文本由于蓝色背景而无法阅读”。

  • 用户注意到,中文版 GitHub 文档页面顶部横幅的蓝色使横幅中的文本不可读。
  • 用户在仓库中创建一个议题,指出了问题并提出了修复建议(即对横幅使用不同的背景色)。
  • 随后进行了讨论,最终就适用的修复方法达成共识。
  • 然后,参与者可以创建包含修复方法的拉取请求。

拉取请求场景

  • 我想修复仓库中的拼写错误。
  • 我想对仓库进行更改。
  • 我想进行更改以修复问题。
  • 我想评论其他人建议的更改。

拉取请求示例

此示例说明了 GitHub 用户如何在我们的文档开源仓库中创建拉取请求以修复拼写错误。

在拉取请求的“对话”选项卡,作者解释了其创建拉取请求的原因。

拉取请求的“对话”选项卡的屏幕截图。

拉取请求的“文件更改”选项卡显示已实现的修补程序。

拉取请求的“已更改的文件”选项卡的屏幕截图。

  • 此参与者发现仓库中的拼写错误。
  • 用户创建包含修复方法的拉取请求。
  • 仓库维护员审查拉取请求、发表评论并合并它。

GitHub Discussions 的场景

  • 我有一个不一定与仓库中的特定文件相关的问题。
  • 我想与协作者或团队分享消息。
  • 我想发起或参与开放式对话。
  • 我想向社区发布公告。

GitHub Discussions 示例

此示例显示了 GitHub 文档开源仓库的 GitHub Discussions 欢迎帖子,并说明了团队希望如何与社区合作。

讨论示例的屏幕截图,标题为“欢迎使用 GitHub 文档讨论”。

这位社区维护员发起讨论以欢迎社区成员,并请成员自我介绍。 这个帖子营造了欢迎访客和参与者的氛围。 这个帖子还阐明,团队乐于帮助用户参与仓库。

后续步骤

这些示例向您展示了如何决定哪种工具是您在 GitHub Enterprise Cloud 上进行对话的最佳工具。 但这仅仅是个开始;您可以做更多的工作来根据需求定制这些工具。

例如,对于议题,您可以用标签标记议题以支持更快的搜索,并创建议题模板以帮助参与者打开有意义的议题。 有关详细信息,请参阅“关于议题”和“关于议题和拉取请求模板”。

对于拉取请求,如果您提议的更改仍在进行中,您可以创建拉取请求草稿。 草稿拉取请求在标记为可供审查之前无法合并。 有关详细信息,请参阅“关于拉取请求”。

对于 GitHub Discussions,可以设置行为准则并将包含社区重要信息的讨论置顶。 有关详细信息,请参阅“关于讨论”。

若要了解一些有助于传达的高级格式设置功能,请参阅“有关在 GitHub 上编写的快速入门”。