|
| 1 | +--- |
| 2 | +title: Managing issue fields in your organization |
| 3 | +intro: 'You can create and manage custom issue fields to collect structured metadata across all issues in your organization.' |
| 4 | +redirect_from: |
| 5 | + - /issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization |
| 6 | +versions: |
| 7 | + feature: issue-fields |
| 8 | +type: overview |
| 9 | +topics: |
| 10 | + - Project management |
| 11 | +shortTitle: 'Managing issue fields' |
| 12 | +permissions: 'Organization owners can create and manage issue fields.' |
| 13 | +--- |
| 14 | + |
| 15 | +{% data reusables.issues.issue-fields-public-preview-note %} |
| 16 | + |
| 17 | +Issue fields let you add structured metadata to issues across your organization. Instead of relying on labels or free-text workarounds, you can create fields like priority, effort, impact, or any custom category your team needs. Fields are defined at the organization level and apply across all repositories in your organization. |
| 18 | + |
| 19 | +## About issue field types |
| 20 | + |
| 21 | +You can create up to 25 issue fields per organization. The following field types are available: |
| 22 | + |
| 23 | +* **Single-select**: choose one option from a predefined list. Options can have names, descriptions, and colors. |
| 24 | +* **Text**: capture free-form text. URLs are automatically detected and displayed as clickable links. |
| 25 | +* **Number**: accept numeric input, including decimals. |
| 26 | +* **Date**: provide a date picker for selecting dates. |
| 27 | + |
| 28 | +## Default fields |
| 29 | + |
| 30 | +When issue fields are enabled for your organization, four default fields are created automatically: |
| 31 | + |
| 32 | +* **Priority** (single-select): Urgent, High, Medium, Low |
| 33 | +* **Effort** (single-select): High, Medium, Low |
| 34 | +* **Start date** (date) |
| 35 | +* **Target date** (date) |
| 36 | + |
| 37 | +These default fields are fully customizable. You can edit their names, descriptions, and options, or delete them if they don't fit your workflow. |
| 38 | + |
| 39 | +## Creating an issue field |
| 40 | + |
| 41 | +{% data reusables.profile.access_org %} |
| 42 | +{% data reusables.profile.org_settings %} |
| 43 | +1. In the "Planning" section of the sidebar, click **Issue fields**. |
| 44 | +1. Click **New field**. |
| 45 | +1. Under "Field name", type the name of your new field. |
| 46 | +1. Optionally, under "Description", type a description to help others understand the purpose of the field. |
| 47 | +1. Under "Field type", select the type of field you want to create. |
| 48 | +1. If you selected **Single-select**, add options for the field: |
| 49 | + * Click **Add option** and type the option name. |
| 50 | + * Optionally, to set a color for an option, click {% octicon "kebab-horizontal" aria-label="open option menu" %} next to the option, click **Edit option**, choose a color, and click **Save**. |
| 51 | + * Repeat to add more options. |
| 52 | +1. Under "Field Visibility", choose one of the following: |
| 53 | + * **Permissions**: choose who can see the field and its value. Options are **Organization only** (default) or **Public**. This setting only applies to issues in public repositories. |
| 54 | + * **Pin to types**: click {% octicon "pencil" aria-label="edit pinning" %} to choose which issue types show this field in the issue viewer and creator. Select one or more issue types, or "Issues without a type". Fields that are not pinned and have no value will stay hidden in the issue viewer and creator. |
| 55 | +1. Click **Create**. |
| 56 | + |
| 57 | +## Editing an issue field |
| 58 | + |
| 59 | +{% data reusables.profile.access_org %} |
| 60 | +{% data reusables.profile.org_settings %} |
| 61 | +1. In the "Planning" section of the sidebar, click **Issue fields**. |
| 62 | +1. To the right of the field you want to edit, click {% octicon "kebab-horizontal" aria-label="open field options" %}. |
| 63 | +1. Click **Edit** and make your changes. |
| 64 | +1. Click **Save field**. |
| 65 | + |
| 66 | +## Deleting an issue field |
| 67 | + |
| 68 | +When you delete an issue field, all values set on issues for that field are permanently removed. |
| 69 | + |
| 70 | +{% data reusables.profile.access_org %} |
| 71 | +{% data reusables.profile.org_settings %} |
| 72 | +1. In the "Planning" section of the sidebar, click **Issue fields**. |
| 73 | +1. To the right of the field you want to delete, click {% octicon "kebab-horizontal" aria-label="open field options" %}. |
| 74 | +1. Click **Delete** and confirm the deletion. |
| 75 | + |
| 76 | +## Reordering issue fields |
| 77 | + |
| 78 | +The order of pinned fields is managed per issue type. The field order determines how fields appear in the issue sidebar and the issue creation modal. |
| 79 | + |
| 80 | +{% data reusables.profile.access_org %} |
| 81 | +{% data reusables.profile.org_settings %} |
| 82 | +1. In the "Planning" section of the sidebar, click **Issue types**. |
| 83 | +1. Click the issue type you want to reorder fields for. |
| 84 | +1. Under "Pinned issue fields", drag fields to reorder them. |
| 85 | +1. Click **Save**. |
| 86 | + |
| 87 | +## Pinning fields to issue types |
| 88 | + |
| 89 | +You can associate issue fields with specific issue types so that only the most relevant fields appear when creating or viewing issues of that type. For example, you can pin "Severity" to bugs and "Impact" to features. |
| 90 | + |
| 91 | +{% data reusables.profile.access_org %} |
| 92 | +{% data reusables.profile.org_settings %} |
| 93 | +1. In the "Planning" section of the sidebar, click **Issue fields**. |
| 94 | +1. Click the field you want to pin. |
| 95 | +1. Under "Pin to types", click {% octicon "pencil" aria-label="edit pinning" %} and select the issue types this field should appear on. |
| 96 | +1. Click **Save field**. |
| 97 | + |
| 98 | +Pinned fields automatically appear in the issue sidebar based on the selected issue type. To pin fields to issues that have no type, select the "Issues without a type" option. |
| 99 | + |
| 100 | +> [!NOTE] |
| 101 | +> Fields must be pinned to at least one issue type, or to "Issues without a type", to appear in the issue sidebar. Fields that are not pinned to any type are only accessible via the **Add field** button or in projects. |
| 102 | +
|
| 103 | +## Setting field visibility |
| 104 | + |
| 105 | +For organizations with public repositories, you can control whether each issue field is visible to everyone or only to organization members and collaborators. |
| 106 | + |
| 107 | +{% data reusables.profile.access_org %} |
| 108 | +{% data reusables.profile.org_settings %} |
| 109 | +1. In the "Planning" section of the sidebar, click **Issue fields**. |
| 110 | +1. To the right of the field, click {% octicon "kebab-horizontal" aria-label="open field options" %}. |
| 111 | +1. Click **Edit**. |
| 112 | +1. Under "Field Visibility", choose one of the following: |
| 113 | + * **Organization only**: the field is visible only to organization members and repository collaborators with at least read access. |
| 114 | + * **Public**: the field is visible to anyone viewing the issue. |
| 115 | +1. Click **Save**. |
| 116 | + |
| 117 | +By default, all new and existing fields are set to "Organization only". Visibility settings are enforced across the web UI, API, issue timeline events, and search suggestions. |
| 118 | + |
| 119 | +## Issue fields and projects |
| 120 | + |
| 121 | +Issue fields are available in any project across your organization. For details on adding, removing, and editing issue fields in projects, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields#using-issue-fields-in-projects). |
| 122 | + |
| 123 | +### Field limits in projects |
| 124 | + |
| 125 | +Projects support up to 50 fields in total, and issue fields and system fields count toward this limit. If a project is already at the field limit, you need to remove existing fields before issue fields can be added. |
| 126 | + |
| 127 | +## Limits |
| 128 | + |
| 129 | +| Resource | Limit | |
| 130 | +|----------|-------| |
| 131 | +| Issue fields per organization | 25 | |
| 132 | +| Options per single-select field | 50 | |
| 133 | +| Pinned fields per issue type | 10 | |
| 134 | +| Total fields in a project (including issue fields and system fields) | 50 | |
0 commit comments