GitHub 中的一个问题是一个项目的错误跟踪器,在每个存储库中都有自己的部分。它可用于讨论,其中包括各种内容,例如报告该存储库的错误、提出问题甚至要求特定功能。这是跟踪项目任务和改进的好地方。擅长编写问题通常有助于构建更好的开源项目,并将帮助其他贡献者更好地理解您的项目并为您提供帮助。
要在您的存储库中创建新问题,请导航到您要提出问题的存储库,然后转到问题选项卡,如下所示:
导航到问题选项卡后,单击新问题为您的项目创建问题,如下所示:
然后给出一个合适的标题和有关该问题的详细信息。作为一个例子,让我们看一下 angular 存储库,它是一个 Web 框架:
问题特点
一个问题包含以下实体:
- 标题和描述清楚地解释了问题的含义。它应该简明扼要,并且应该清楚易懂。
- 颜色编码的标签有助于为您过滤掉特定问题。这类似于我们在电子邮件中看到的分类。一个问题可以有多个标签,并且可以一次被一个或多个标签过滤掉。标签问题如下所示:
- 里程碑有助于跟踪问题并合并请求,以在特定时间段内实现更广泛的目标。它们可以被可视化为特定类型问题的容器。这些可以是各种类型,例如:
- 版本 1.0 – 用于特定版本的软件版本。
- Beta Launch – 在启动项目的 Beta 版本之前,将需要修复的错误归档。
- 三月到期 – 提交您希望在三月处理的问题。
- 重新设计 – 与项目设计相关的问题。
如果您无法设置里程碑,那是因为您没有权限。只有当仓库所有者让你成为贡献者时才能解决这个问题。
- 受托人,负责一次处理特定问题并推进该问题。它们也由存储库所有者分配。
- 任何有权访问存储库的人都可以发表评论。
问题中的其他一些有用功能是:
- @mention – 在 GitHub 中引用其他用户的一个好方法是使用 @mention 功能。要将特定问题通知其他用户并寻求他们的帮助或指导,请使用@username 标记他们,这会向他们发送通知以调查该问题并为其做出贡献。它还可以用于通知团队而不是个人,在这种情况下,所有团队成员都会收到通知。
- 参考资料——有时有些问题依赖于其他问题。这些问题可以通过在依赖于当前问题的其他问题的 issue_number 前面放置 # 来引用,并在提交前加上“Fixed”、“Fixes”、“Closed”、“Close”或“Close”。
- 搜索– 在问题部分的右上角,有一个搜索框,可让您搜索存在的问题。可以根据关键字、状态或受让人来搜索问题。
最后,有一个问题仪表板,其中列出了您一直在处理的所有项目中的所有问题,包括:
- 您拥有和协作处理的存储库中的所有问题。
- 分配给您的问题。
- 您创建的问题。