Skip to main content

创建议题

议题可以通过多种方式创建,因此您可以为工作流程选择最方便的方法。

People with read access can create an issue in a repository where issues are enabled.

议题可用于跟踪漏洞、增强功能或其他请求。 更多信息请参阅“关于议题”。

仓库管理员可以禁用仓库的议题。 更多信息请参阅“禁用议题”。

从仓库创建议题

  1. 在 GitHub.com 上,导航到仓库的主页面。

  2. 在仓库名称下,单击 Issues(议题)

    议题选项卡

  3. 单击 New issue(新建议题)新建议题按钮

  4. 如果您的仓库使用议题模板,请在要打开的议题类型旁边单击 Get started(开始)Select the type of issue you want to create或者,如果您想打开的议题类型未包括在可用选项中,单击 Open a blank issue(打开空白议题)打开空白议题的链接

  5. 键入议题的标题和说明。 示例议题

  6. 如果您是项目维护员,可以将议题分配给某人将其添加到项目板将其与里程碑关联应用标签

  7. 完成后,单击 Submit new issue(提交新议题)

使用 GitHub CLI 创建议题

GitHub CLI 是用于从计算机的命令行使用 GitHub 的开源工具。 从命令行操作时,您可以使用 GitHub CLI 来节省时间并避免切换上下文。 要了解 GitHub CLI 的更多信息,请参阅“关于 GitHub CLI”。

要创建议题,请使用 gh issue create 子命令。 若要跳过交互式提示,请包括 --body and the --title 标志。

gh issue create --title "My new issue" --body "Here are more details."

您还可以指定受理人、标签、里程碑和项目。

gh issue create --title "My new issue" --body "Here are more details." --assignee @me,monalisa --label "bug,help wanted" --project onboarding --milestone "learning codebase"

从评论创建议题

您可以从议题或拉取请求中的评论打开新议题。 从评论打开议题时,该议题包含一个代码段,显示评论的原始发布位置。

  1. 导航到您要从中打开议题的评论。
  2. 在该评论中,单击 拉取请求审查评论中的烤肉串式按钮
  3. 单击 Reference in new issue(新议题中的引用)新议题中的引用菜单项
  4. 使用“Repository(仓库)”下拉菜单,并选择要在其中打开议题的仓库。 新议题的仓库下拉列表
  5. 键入议题的描述性标题和正文。 新议题的标题和正文
  6. 单击 Create issue(创建过滤器)创建新议题的按钮
  7. 如果您是项目维护员,可以将议题分配给某人将其添加到项目板将其与里程碑关联应用标签
  8. 完成后,单击 Submit new issue(提交新议题)

从代码创建议题

您可以从文件或拉取请求的特定代码行打开新议题。 从代码打开议题时,议题包含小片段,其中显示所选代码的行或范围。 只能打开存储代码的仓库中的议题。

在从代码打开的议题中渲染的代码片段

  1. 在 GitHub.com 上,导航到仓库的主页面。
  2. 找到要在议题中引用的代码:
    • 要打开文件中代码相关的议题,请找到该文件。
    • 要打开拉取请求中代码相关的议题,请找到该拉取请求并单击 Files changed(文件已更改)。 然后浏览到含有要包含在评论中的代码的文件,并单击 View(查看)
  3. 选择是选择一行还是一个范围:
    • 要选择单行代码,请单击行号以高亮显示该行。 选择了单行代码的文件
      • 要选择代码范围,请单击范围内第一行的行号以高亮显示代码行。 然后,将鼠标停在代码范围的最后一行,按 Shift,再单击行号以高亮显示范围。 选择了一个代码范围的文件
  4. 在代码范围左侧,单击 。 在下拉菜单中,单击 Reference in new issue(新议题中的引用)带有从所选行打开新议题的选项的烤肉串式菜单
  5. 键入议题的标题和说明。 示例议题
  6. 如果您是项目维护员,可以将议题分配给某人将其添加到项目板将其与里程碑关联应用标签
  7. 完成后,单击 Submit new issue(提交新议题)

从讨论创建议题

对存储库具有分类权限的人员可以从讨论创建议题。

从讨论创建议题时,讨论帖子的内容将自动包含在议题正文中,并且将保留所有标签。 从讨论创建议题不会将讨论转换为议题或删除现有讨论。 有关 GitHub Discussions 的更多信息,请参阅“关于讨论”。

  1. 在您的存储库或组织名称下,单击 Discussions(讨论)仓库的"Discussions(讨论)"选项卡
  2. 在讨论列表中,单击要查看的讨论。 仓库讨论列表中的讨论
  3. 在右侧边栏中,单击 Create issue from discussion(从讨论创建议题)用于从讨论创建议题的按钮
  4. 键入议题的标题和说明。 示例议题
  5. 如果您是项目维护员,可以将议题分配给某人将其添加到项目板将其与里程碑关联应用标签
  6. 完成后,单击 Submit new issue(提交新议题)

从项目板说明创建议题

如果使用项目板对工作进行跟踪和排列优先级,您可以将项目板注释转换为议题。 更多信息请参阅“关于项目板”和“向项目板添加备注”。

从任务列表项创建议题

在议题中,您可以使用任务列表将工作分解为较小的任务,并跟踪要完成的完整工作集。 如果任务需要进一步跟踪或讨论,您可以通过在任务上方悬停并单击任务右上角的 将任务转换为议题。 更多信息请参阅“关于任务列表”。

从 URL 查询创建议题

您可以使用查询参数打开议题。 查询参数是 URL 中可以定制的部分,用于在 GitHub 上共享特定的网页视图,如搜索过滤结果或议题模板。 要创建自己的查询参数,必须将键与值进行配对。

提示:也可使用默认标签、受理人和议题标题创建议题模板。 更多信息请参阅“使用模板鼓励有用的议题和拉取请求”。

必须具有适当的权限才可执行使用相关查询参数的操作。 例如,必须具有向议题添加标签的权限才可使用 labels 查询参数。 更多信息请参阅“组织的仓库角色”。

如果使用查询参数创建无效的 URL,或者没有适当的权限,URL 将返回 404 未找到错误页。 如果您创建的 URL 超过服务器限制,URL 将返回 414 URI 过长错误页面。

查询参数示例
titlehttps://github.com/octo-org/octo-repo/issues/new?labels=bug&title=New+bug+report 使用标签 "bug" 和标题 "New bug report" 创建议题。
正文https://github.com/octo-org/octo-repo/issues/new?title=New+bug+report&body=Describe+the+problem. 创建一个标题为 "New bug report" 的议题,并且议题正文中有评论 "Describe the problem"。
labelshttps://github.com/octo-org/octo-repo/issues/new?labels=help+wanted,bug 使用标签 "help wanted" 和 "bug" 创建议题。
里程碑https://github.com/octo-org/octo-repo/issues/new?milestone=testing+milestones 创建包含里程碑 "testing milestones" 的议题。
assigneeshttps://github.com/octo-org/octo-repo/issues/new?assignees=octocat 创建议题并分配到 @octocat。
projectshttps://github.com/octo-org/octo-repo/issues/new?title=Bug+fix&projects=octo-org/1 创建标题为 "Bug fix" 的议题并将其添加到组织的项目板 1。
模板https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md 使用模板在议题正文中创建议题。 template 查询参数支持仓库根目录 docs/.github/ISSUE_TEMPLATE 子目录中存储的模板。 更多信息请参阅“使用模板鼓励有用的议题和拉取请求”。

从 代码扫描 警报创建议题

注意: 议题中 代码扫描 警报的跟踪处于测试阶段,可能会发生更改。

此功能支持使用 GitHub Actions 在本地运行分析,或使用现有 CI/CD 基础结构以及第三方 代码扫描 工具在外部运行分析,但使用第三方跟踪工具。

如果您使用议题来跟踪工作并确定其优先级,则可以使用议题来跟踪 代码扫描 警报。

有关创建议题以跟踪 代码扫描 警报的详细信息,请参阅“使用任务列表跟踪议题中的 代码扫描 警报”。

延伸阅读