JIRA - Edit an Issue
JIRA - Editing an Issue
Section titled “JIRA - Editing an Issue”Modifying details of an existing issue in JIRA is a fundamental task. You might need to update its summary, description, assignee, priority, status, or any other custom fields.
How to Edit an Issue
Section titled “How to Edit an Issue”There are a few ways to edit an issue:
1. Using the ‘Edit’ Button
Section titled “1. Using the ‘Edit’ Button”- Navigate to the specific issue you want to modify and open its detailed view.
- Locate the ‘Edit’ button. This is typically found near the top of the issue view page, often amongst other action buttons.
- Clicking ‘Edit’ will open an ‘Edit Issue’ dialog or page, which resembles the ‘Create Issue’ screen, displaying all editable fields.
In the ‘Edit Issue’ screen, modify the desired fields (e.g., Summary, Description, Assignee, Priority, Labels, etc.). Once you’ve made your changes, click the ‘Update’ or ‘Save’ button at the bottom of the form.
2. Inline Editing
Section titled “2. Inline Editing”For quick changes to certain fields, JIRA often supports inline editing:
- In the issue view, hover your mouse cursor over the field you wish to change (e.g., Summary, Description, Priority).
- If inline editing is available for that field, a pencil icon or similar visual cue might appear, or the field itself might become clickable.
- Click on the field or the pencil icon. The field will become editable directly on the page.
- Make your changes and then click a checkmark icon, press Enter, or click outside the field to save the change (the exact mechanism can vary slightly based on the JIRA version and field type).
Inline editing is convenient for minor corrections or quick updates without opening the full edit dialog.
3. Keyboard Shortcut
Section titled “3. Keyboard Shortcut”Many JIRA instances allow you to press the ‘e’ key while viewing an issue to quickly open the ‘Edit Issue’ dialog.
What You Can Edit
Section titled “What You Can Edit”The fields available for editing depend on your project’s configuration and your permissions. Common editable fields include:
- Summary: The main title of the issue.
- Description: Detailed information about the issue.
- Issue Type: E.g., Bug, Task, Story (changing this might affect available fields).
- Assignee: The user responsible for working on the issue.
- Reporter: The user who created the issue.
- Priority: The urgency of the issue.
- Labels: Keywords to categorize or filter issues.
- Epic Link: If the issue is part of an Epic.
- Sprint: The sprint to which the issue is assigned (for Scrum projects).
- Story Points: Effort estimation (for Agile projects).
- Status: While status changes are often done via workflow transitions, some edits might be possible here or trigger a transition screen.
- Custom Fields: Any additional fields configured for your JIRA project.
After updating, the issue view page will refresh to display the modified details. All changes to an issue are typically logged in its ‘History’ tab, providing an audit trail.
Best Practices for Editing Issues
Section titled “Best Practices for Editing Issues”- Be Clear and Concise: Ensure that any changes, especially to the summary or description, are clear and accurately reflect the current state of the issue.
- Comment on Significant Changes: If you make a major change (e.g., altering scope or priority significantly), add a comment explaining the reason for the change.
- Respect Workflow: Be mindful of the project’s workflow. Some fields might be restricted or their change might imply a status transition.
- Permissions: Remember that your ability to edit certain fields or issues may be restricted by project permissions.
For updating multiple issues at once, JIRA offers a ‘Bulk Edit’ feature, typically accessible from the issue navigator search results. This is a more advanced topic, useful for large-scale changes.