Issue fields let you add structured metadata to issues across your repositories. 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 or user level and apply across all repositories.
About issue field types
You can create up to 25 issue fields. The following field types are available:
- Single-select: choose one option from a predefined list. Options can have names, descriptions, and colors.
- Text: capture free-form text. URLs are automatically detected and displayed as clickable links.
- Number: accept numeric input, including decimals.
- Date: provide a date picker for selecting dates.
Default fields
When issue fields are enabled, four default fields are created automatically:
- Priority (single-select): Urgent, High, Medium, Low
- Effort (single-select): High, Medium, Low
- Start date (date)
- Target date (date)
These default fields are pinned to issue types as follows:
| Field | No type | Bug | Task | Feature |
|---|---|---|---|---|
| Priority | ||||
| Effort | ||||
| Start date | ||||
| Target date |
These default fields are fully customizable. You can edit their names, descriptions, and options, or delete them if they don't fit your workflow.
提示
You can rename options, change their colors, reorder them, or add new values to match your team's workflow. For example, you could change Effort options to T-shirt sizes (XS, S, M, L, XL).
Creating an issue field
- Under your organization name or user profile, click Settings.
- In the "Planning" section of the sidebar, click Issue fields.
- Click New field.
- Under "Field name", type the name of your new field.
- Optionally, under "Description", type a description to help others understand the purpose of the field.
- Under "Field type", select the type of field you want to create.
- If you selected Single-select, add options for the field:
- Click Add option and type the option name.
- Optionally, to set a color for an option, click next to the option, click Edit option, choose a color, and click Save.
- Repeat to add more options.
- Under "Field Visibility", choose one of the following:
- Permissions: choose who can see the field and its value. Options are Restricted (default) or Public. This setting only applies to issues in public repositories.
- Pin to types: click 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.
- Click Create.
Editing an issue field
- Under your organization name or user profile, click Settings.
- In the "Planning" section of the sidebar, click Issue fields.
- To the right of the field you want to edit, click .
- Click Edit and make your changes.
- Click Save field.
Deleting an issue field
When you delete an issue field, all values set on issues for that field are permanently removed.
- Under your organization name or user profile, click Settings.
- In the "Planning" section of the sidebar, click Issue fields.
- To the right of the field you want to delete, click .
- Click Delete and confirm the deletion.
提示
If you don't want to use issue fields, you can delete all default fields from your settings. This removes them from all issues. You can re-create fields at any time.
Reordering issue fields
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.
- Under your organization name or user profile, click Settings.
- In the "Planning" section of the sidebar, click Issue types.
- Click the issue type you want to reorder fields for.
- Under "Pinned issue fields", drag fields to reorder them.
- Click Save.
Pinning fields to issue types
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.
- Under your organization name or user profile, click Settings.
- In the "Planning" section of the sidebar, click Issue fields.
- Click the field you want to pin.
- Under "Pin to types", click and select the issue types this field should appear on.
- Click Save field.
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.
注意
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.
If a field is not appearing on your issues, check that it is pinned to the relevant issue type or to "Issues without a type". Fields that are not pinned and have no value set are hidden from the issue sidebar.
Setting field visibility
For organizations or user profiles with public repositories, you can control whether each issue field is visible to everyone or only to members, repository owners, and collaborators.
- Under your organization name or user profile, click Settings.
- In the "Planning" section of the sidebar, click Issue fields.
- To the right of the field, click .
- Click Edit.
- Under "Field Visibility", choose one of the following:
- Restricted: the field is visible only to organization members and repository collaborators with at least read access in organization-owned repositories, or to the repository owner and collaborators with at least read access in personally owned repositories.
- Public: the field is visible to anyone viewing the issue.
- Click Save.
By default, all new and existing fields are set to "Restricted". Visibility settings are enforced across the web UI, API, issue timeline events, and search suggestions.
Issue fields and projects
Issue fields are available in any project across your organization or user profile, including public and internal projects. For details on adding, removing, and editing issue fields in projects, see 关于项目中的问题字段.
Visibility in public and internal projects
Only fields with Public visibility are available in public and internal projects. Fields set to Restricted are not displayed. When adding fields to a public project, only public-visibility fields appear in the add-field dialog.
If a field's visibility is changed from "Public" to "Restricted" while in use in a public project, the field is automatically removed from the project. To restore it, change the field's visibility back to "Public."
Migrating from project fields to issue fields
If you already use project-level custom fields for metadata like priority or effort, you can adopt issue fields to centralize those values at the issue level.
- Issue fields are the source of truth. The value lives on the issue and is consistent across all projects the issue belongs to.
- Project fields are scoped to a single project. The same issue can have different project field values in different projects.
- Both can coexist. You do not need to remove project fields immediately, but having both can cause confusion if they track the same concept (for example, two "Priority" fields).
- To migrate, create the equivalent issue field, then remove the project-level field from your project views when your team is ready.
Field limits in projects
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.
Limits
| Resource | Limit |
|---|---|
| Issue fields | 25 |
| Options per single-select field | 100 |
| Pinned fields per issue type | 10 |
| Total fields in a project (including issue fields and system fields) | 50 |