Skip to main content

管理组织中的问题字段

可以创建和管理自定义问题字段,以收集组织中所有问题的结构化元数据。

谁可以使用此功能?

Organization owners can create and manage issue fields.

注意

问题字段当前位于 公开预览 中,可能会更改。 若要共享反馈,请参阅 社区讨论

问题字段允许向整个组织内的问题添加结构化元数据。 为了避免依赖标签或自由文本这种临时解决方法,可以创建诸如优先级、工作量、影响或满足团队具体需求的任何自定义类别等字段。 字段在组织级别定义,并应用于组织中的所有存储库。

关于问题字段类型

每个组织最多可以创建 25 个问题字段。 以下字段类型可用:

  • 单选:从预定义列表中选择一个选项。 选项可以具有名称、说明和颜色。
  • 文本:捕获自由格式的文本。 URL 会自动检测并显示为可单击的链接。
  • 数字:接受数字输入,包括小数。
  • 日期:提供用于选择日期的日期选取器。

默认字段

为组织启用问题字段时,会自动创建四个默认字段:

  • 优先级 (单选):紧急、高、中、低
  • 工作量 (单选):高、中、低
  • 开始日期 (日期)
  • 目标日期 (日期)

这些默认字段固定到问题类型,如下所示:

领域无类型Bug任务功能
优先级
努力
开始日期
目标日期

这些默认字段是完全可自定义的。 可以编辑其名称、说明和选项,或者如果它们不适合工作流,请将其删除。

提示

可以重命名选项、更改其颜色、重新排序或添加新值以匹配团队的工作流。 例如,可以将“努力”选项更改为 T 恤大小(XS、S、M、L、XL)。

创建问题字段

  1. 在 GitHub 的右上角,单击个人资料图片,然后单击“ Your organizations”****。

  2. 单击以选择一个组织。

  3. 在组织名称下,单击 “Settings”****。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    组织配置文件中选项卡的屏幕截图。 “设置”选项卡以深橙色标出。

  4. 在边栏的“规划”部分中,单击问题字段

  5. 单击“新建字段”。

  6. 在“字段名称”下,键入新字段的名称。

  7. (可选)在“说明”下,键入说明以帮助其他人了解字段的目的。

  8. 在“字段类型”下,选择要创建的字段的类型。

  9. 如果选择 了“单选”,请为字段添加选项:

    • 单击“ 添加”选项 并键入选项名称。
    • (可选)若要设置选项的颜色,请单击 选项旁边的选项,单击“ 编辑”选项,选择颜色,然后单击“ 保存”。
    • 重复添加更多选项。
  10. 在“字段可见性”下,选择以下选项之一:

    • 权限:选择谁可以查看字段及其值。 选项 仅限组织 (默认)或 公共。 此设置仅适用于公共存储库中的问题。
    • 固定到类型:单击 以选择问题查看器和创建者中显示此字段的问题类型。 选择一个或多个问题类型,或“没有类型的问题”。 未固定且无值的字段将在问题查看器和创建器中保持隐藏状态。
  11. 单击 “创建”

编辑问题字段

  1. 在 GitHub 的右上角,单击个人资料图片,然后单击“ Your organizations”****。

  2. 单击以选择一个组织。

  3. 在组织名称下,单击 “Settings”****。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    组织配置文件中选项卡的屏幕截图。 “设置”选项卡以深橙色标出。

  4. 在边栏的“规划”部分中,单击问题字段

  5. 在要编辑的字段右侧,单击

  6. 单击 “编辑” 并进行更改。

  7. 单击“ 保存”字段

删除问题字段

删除问题字段时,将永久删除针对该字段的问题设置的所有值。

  1. 在 GitHub 的右上角,单击个人资料图片,然后单击“ Your organizations”****。

  2. 单击以选择一个组织。

  3. 在组织名称下,单击 “Settings”****。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    组织配置文件中选项卡的屏幕截图。 “设置”选项卡以深橙色标出。

  4. 在边栏的“规划”部分中,单击问题字段

  5. 在要删除的字段右侧,单击

  6. 单击“ 删除 ”并确认删除。

提示

如果不想使用问题字段,可以从组织设置中删除所有默认字段。 这会将它们从您的组织中的所有问题中移除。 可以随时重新创建字段。

重新排序问题字段

固定字段的顺序按问题类型来管理。 字段顺序确定字段在问题边栏和问题创建模式中的显示方式。

  1. 在 GitHub 的右上角,单击个人资料图片,然后单击“ Your organizations”****。

  2. 单击以选择一个组织。

  3. 在组织名称下,单击 “Settings”****。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    组织配置文件中选项卡的屏幕截图。 “设置”选项卡以深橙色标出。

  4. 在边栏的“规划”部分中,单击“ 问题类型”。

  5. 单击要重新排序字段的问题类型。

  6. 在“已固定的问题字段”下,拖动字段以对其进行重新排序。

  7. 单击“ 保存”。

将字段固定到问题类型

可以将问题字段与特定问题类型相关联,以便在创建或查看该类型的问题时仅显示最相关的字段。 例如,可以将“严重性”关联到 bug,将“影响”关联到特性。

  1. 在 GitHub 的右上角,单击个人资料图片,然后单击“ Your organizations”****。

  2. 单击以选择一个组织。

  3. 在组织名称下,单击 “Settings”****。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    组织配置文件中选项卡的屏幕截图。 “设置”选项卡以深橙色标出。

  4. 在边栏的“规划”部分中,单击问题字段

  5. 单击要固定的字段。

  6. 在“固定到类型”下,单击 并选择此字段应显示的问题类型。

  7. 单击“ 保存”字段

固定字段自动根据所选问题类型显示在问题边栏中。 若要将字段固定到没有类型的问题,请选择“没有类型的问题”选项。

注意

字段必须被设置为至少一个事项类型,或“无类型事项”,才能显示在事项边栏中。 未固定到任何类型的 字段只能通过“添加字段 ”按钮或在项目中访问。

如果某个字段未出现在问题上,请检查它是否已固定到相关问题类型或“没有类型的问题”。 未固定且未设置值的字段将在问题侧边栏中隐藏。

设置字段可见性

对于具有公共存储库的组织,可以控制每个问题字段对每个人可见,还是仅对组织成员和协作者可见。

  1. 在 GitHub 的右上角,单击个人资料图片,然后单击“ Your organizations”****。

  2. 单击以选择一个组织。

  3. 在组织名称下,单击 “Settings”****。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    组织配置文件中选项卡的屏幕截图。 “设置”选项卡以深橙色标出。

  4. 在边栏的“规划”部分中,单击问题字段

  5. 在字段右侧,单击

  6. 单击 “编辑”

  7. 在“字段可见性”下,选择以下选项之一:

    • 仅限组织:该字段仅对至少具有读取访问权限的组织成员和存储库协作者可见。
    • 公共:此字段对查看此问题的任何人可见。
  8. 单击“ 保存”。

默认情况下,所有新字段和现有字段都设置为“仅限组织”。 可见性设置在 Web UI、API、问题时间线事件和搜索建议中强制实施。

问题字段和项目

问题字段可在组织内的任何项目中使用,包括公共项目和内部项目。 有关在项目中添加、删除和编辑问题字段的详细信息,请参阅 关于项目中的问题字段

公共项目和内部项目中的可见性

公共可见性的字段在公共项目和内部项目中可用。 设置为仅限组织的字段不会显示。 向公共项目添加字段时,仅显示加载项对话框中的公共可见性字段。

如果某个字段正在公共项目中使用时,其可见性从“公开”更改为“仅限组织”,系统会自动将该字段从项目中移除。 若要还原它,请将字段的可见性更改回“公共”。

从项目字段迁移到问题字段

如果已对元数据(例如优先级或工作量)使用项目级自定义字段,则可以采用问题字段在问题级别集中这些值。

  • 问题字段是事实来源。 该值存储在议题中,并且在该议题所属的所有项目中保持一致。
  • 项目字段仅限于单个项目。 同一问题可以在不同的项目中具有不同的项目字段值。
  • 两者都可以共存。 无需立即删除项目字段,但如果两者跟踪相同的概念(例如两个“优先级”字段),这两者都可能会导致混淆。
  • 若要迁移,请创建等效的问题字段,然后在团队准备就绪时从项目视图中删除项目级字段。

项目中的字段限制

项目总共支持最多 50 个字段,问题字段和系统字段计入此限制。 如果项目已处于字段限制,则需要在添加问题字段之前删除现有字段。

限制

资源Limit
每个组织的问题字段数二十五
每个单选字段的选项100
每个问题类型的固定字段数10
项目中的字段总数(包括问题字段和系统字段)50