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