在 GitHub 上沟通

您可以使用 GitHub 上的不同讨论类型来讨论特定项目和变更，以及更广泛的想法或团队目标。

本文内容

简介

GitHub 提供内置的协作沟通工具，让您能够与社区紧密互动。本快速入门指南将展示如何为您的需求选择合适的工具。

您可以根据想进行的对话类型创建并参与 Issue、拉取请求和团队讨论。

提示

您还可以使用 Copilot Chat 根据您的拉取请求和 Issue 生成想法、大纲或讨论草稿。参见 撰写讨论或博客文章。

GitHub Issue

  • 可用于讨论项目的具体细节，例如错误报告、计划中的改进和反馈。
  • 针对特定仓库，通常有明确的所有者。
  • 常被称为 GitHub 的缺陷跟踪系统。

拉取请求

  • 允许您提出具体的更改。
  • 允许您直接对他人提出的更改进行评论。
  • 针对特定仓库。

GitHub 讨论

  • 类似论坛，最适合用于开放式想法和需要协作的讨论。
  • 可能跨多个仓库。
  • 提供代码库之外的协作体验，允许进行头脑风暴并创建社区知识库。
  • 通常没有明确的所有者。
  • 通常不会产生可执行的任务。

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

Issue 场景

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

Issue 示例

此示例展示了 GitHub 用户如何在我们的文档开源仓库中创建 Issue，以让我们了解一个错误并讨论修复方案。

Screenshot of an issue, with the title "Blue link text in notices is unreadable due to blue background."

  • 一位用户注意到在 GitHub Docs 中文版页面顶部横幅的蓝色背景导致横幅中的文字难以辨认。
  • 该用户在仓库中创建了 Issue，陈述了问题并提出了修复方案（即为横幅使用不同的背景颜色）。
  • 随后展开讨论，最终就应采用的修复方案达成共识。
  • 随后，贡献者可以提交包含该修复的拉取请求。

拉取请求场景

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

拉取请求示例

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

在拉取请求的 Conversation（对话） 选项卡中，作者解释了创建该拉取请求的原因。

Screenshot of the "Conversation" tab of a pull request.

拉取请求的 Files changed（已更改文件） 选项卡显示了实施的修复。

Screenshot of the "Files changed" tab of a pull request.

  • 该贡献者注意到仓库中的拼写错误。
  • 用户创建了包含修复的拉取请求。
  • 仓库维护者审查该拉取请求，进行评论并合并它。

GitHub 讨论场景

  • 我有一个问题，并不一定与仓库中的特定文件相关。
  • 我想与合作者或团队分享资讯。
  • 我想发起或参与一次开放式的讨论。
  • 我想向社区发布公告。

GitHub 讨论示例

此示例展示了 GitHub Discussions 的欢迎贴，说明团队希望如何与社区协作。

Screenshot of an example of a discussion, with the title "Welcome to GitHub Docs Discussions."

该社区维护者发起了一个讨论，欢迎社区并邀请成员自我介绍。此贴营造了友好的氛围，鼓励访客和贡献者参与，并明确团队乐于帮助处理对仓库的贡献。

使用 Copilot 获取上下文

注意

你需要拥有 GitHub Copilot 的访问权限。有关详细信息，请参阅 GitHub Copilot 是什么？。

如果您需要对特定 Issue 或讨论获取更多上下文或澄清，可使用 GitHub Copilot 帮助回答您的问题。这使您能够快速获取洞察、理解复杂的讨论串，并保持与项目目标一致，促进社区内部的协作与知识共享。

在 Issue 或讨论中提问

  1. 在 GitHub 任意页面，点击页面右上角搜索栏旁的 图标。

    Screenshot of the new conversation button, highlighted with a dark orange outline.

  2. 在“Ask Copilot”框中输入问题，并在信息中包含相关 URL。例如，您可以问

    • 解释 https://github.com/monalisa/octokit/issues/1
    • 总结 https://github.com/monalisa/octokit/discussions/4
    • 推荐 https://github.com/monalisa/octokit/issues/2 的下一步操作
    • ISSUE URL 的验收标准是什么？
    • PERSON 在 DISCUSSION URL 中提出的要点是什么？

    如果您在特定 Issue 或讨论中与 GitHub Copilot 对话，则无需在提问时包含 URL。

  3. 可选地，在提交问题后，你可以点击文本框中的按钮来停止响应。

后续步骤

这些示例展示了如何为 GitHub 上的对话选择最佳工具。但这仅是开始，您还可以进一步定制这些工具以满足需求。

例如，对于 Issue，您可以使用标签对 Issue 进行标记，以便更快搜索，并创建 Issue 模板帮助贡献者提交有意义的 Issue。欲了解更多信息，请参阅 关于 Issue 和 关于 Issue 与拉取请求模板。

对于拉取请求，您可以创建草稿拉取请求（draft pull request），如果您的更改仍在进行中。草稿拉取请求在标记为准备审查之前无法合并。欲了解更多信息，请参阅 关于拉取请求。

对于 GitHub Discussions，您可以设置行为准则并置顶包含重要信息的讨论，以供社区使用。欲了解更多信息，请参阅 关于讨论。

要了解一些有助于沟通的高级格式化功能，请参阅 GitHub 写作快速入门。

© . This site is unofficial and not affiliated with GitHub, Inc.