简介
GitHub 提供内置的协作沟通工具,让您可以与您的社区密切互动。本快速入门指南将向您展示如何为您的需求选择合适的工具。
您可以创建和参与 Issue、Pull Request 和 GitHub 讨论,具体取决于您想要进行的对话类型。
GitHub Issue
- 用于讨论项目的具体细节,例如错误报告、计划改进和反馈
- 特定于某个代码库,通常有明确的负责人
- 通常被称为 GitHub 的错误跟踪系统
Pull Request
- 允许您提出具体的更改
- 允许您直接评论其他人提出的建议更改
- 特定于某个代码库
GitHub 讨论
- 类似于论坛,最适合用于开放式想法和讨论,协作至关重要。
- 可能跨越多个代码仓库。
- 提供代码库之外的协作体验,允许头脑风暴和创建社区知识库。
- 通常没有明确的所有者。
- 通常不会产生可执行的任务。
我应该使用哪个讨论工具?
Issue 使用场景
- 我想跟踪任务、增强功能和bug。
- 我想提交bug报告。
- 我想分享关于特定功能的反馈。
- 我想问一个关于代码仓库中文件的问题。
Issue 示例
此示例说明了一个GitHub用户如何在我们的文档开源代码仓库中创建一个Issue,以告知我们一个bug,并讨论解决方案。
- 一位用户注意到GitHub文档中文版页面顶部的横幅蓝色使得横幅中的文字难以阅读。
- 用户在代码仓库中创建了一个Issue,说明了问题并提出了解决方案(即,使用不同的横幅背景颜色)。
- 随后展开了讨论,最终将就应采用的解决方案达成共识。
- 然后,贡献者可以创建一个包含解决方案的Pull Request。
Pull Request 使用场景
- 我想修正代码仓库中的错别字。
- 我想更改代码仓库。
- 我想更改代码以修复Issue。
- 我想评论其他人建议的更改。
Pull Request 示例
此示例说明了一个GitHub用户如何在我们的文档开源代码仓库中创建一个Pull Request来修复一个错别字。
在Pull Request的**讨论**选项卡中,作者解释了他们创建Pull Request的原因。
Pull Request的**已更改文件**选项卡显示了已实施的修复。
- 这位贡献者注意到代码仓库中有一个错别字。
- 用户创建了一个包含修复的Pull Request。
- 代码仓库维护者审查了Pull Request,对其进行了评论,并将其合并。
GitHub Discussions 使用场景
- 我有一个与代码仓库中特定文件无关的问题。
- 我想与我的合作者或团队分享新闻。
- 我想开始或参与开放式对话。
- 我想向我的社区发布公告。
GitHub Discussions 示例
此示例显示了GitHub文档开源代码仓库的GitHub Discussions欢迎帖子,并说明了团队希望如何与社区协作。
这位社区维护者发起了一个讨论来欢迎社区,并邀请成员进行自我介绍。此帖子为访客和贡献者营造了轻松友好的氛围。该帖子还阐明了团队乐于帮助贡献者为代码仓库做出贡献。
后续步骤
这些示例向您展示了如何确定哪个工具最适合您在GitHub上的对话。但这仅仅是一个开始;您可以做更多的事情来根据您的需求定制这些工具。
例如,对于Issue,您可以使用标签标记Issue以加快搜索速度,并创建Issue模板以帮助贡献者打开有意义的Issue。更多信息,请参阅“关于Issue”和“关于Issue和Pull Request模板”。
对于Pull Request,如果您的建议更改仍在进行中,您可以创建草稿Pull Request。草稿Pull Request必须标记为已准备好进行审查后才能合并。更多信息,请参阅“关于Pull Request”。
对于GitHub Discussions,您可以设置行为准则并固定包含社区重要信息的讨论。更多信息,请参阅“关于Discussions”。
要了解一些有助于您沟通的更高级的格式化功能,请参阅“GitHub写作快速入门”。