Editing and collaborating on issues

Complete your work more efficiently with these tips and tricks for editing and collaborating on issues.

In addition to learning about the basics of editing and commenting on an issue, you can refer to this page for help with:

  • Using the wiki toolbar to make your comments and descriptions pop
  • Sharing issues with your team and mentioning other people
  • Keeping track of issues with labels and issue watchers

On this page:

Attaching files and screenshots

If your administrator has enabled file attachments, you and your customers can attach files and screenshots to issues you're working on. See Attaching files and screenshots to issues for more information.

Collaborating on issues

You can easily keep your team informed by using the  button to share an issue with other JIRA users. If your administrator has enabled anonymous access, you can also share issues by entering the email address of a non-JIRA user.

If you want to invite members of your team to help you work on an issue, you can mention them by typing @ and their username in the issue description or comment. People already involved in the issue, like the reporter or a commenter, will be listed first in the user list so you can select them faster. Note that the users you mention will be notified once you save the issue description or comment. 

Editing issue details

What permissions do you need?

To edit an issue, you need the Edit Issue project permission for the issue's relevant project. If you do not have this permission, please contact your administrator. 

To edit an existing issue, select Edit to open the Edit Issue dialog box and modify the issue details. If you want to change the fields you need to edit, select Configure Fields > Custom and choose the fields you want to show or hide. Select Update to save your changes.

Commenting on issues

What permissions do you need?

To add comments to an issue, i.e. to see the Comment button, you must have both of the following project permissions  for the issue's relevant project:

  • Browse Project permission to view the issue to be commented on
  • Add Comments permission to add a comment to the issue.

Note that you automatically become a watcher of the issues that you comment on. You can disable this via the Preferences > Autowatch option in your profile.

 What How 
Add a comment

Simply click Comment and type your comment for the issue.

Delete a comment On the comment you wish to delete, select the trashcan icon located on the comment. Confirm that you want to remove this comment from the issue by selecting Delete when prompted.
Edit a comment

Select located on the comment, and edit the text or restrictions (Viewable by...) as needed. When you save your revised comment, you'll see 'edited' displayed to indicate that the comment has been edited:

You can hover over 'edited' to see who edited the comment and when.

Link to a comment

Right-click on the Permlink icon on the comment, then copy the permanent link to the comment. Paste the copied permanent link into your email or chat message.

Clicking the permanent link takes you to that particular comment in the JIRA issue. If your JIRA issue contains an extensive list of comments, the issue page will automatically be scrolled down so that the linked comment is visible.

Restrict a comment

Apply viewing restrictions to a comment by selecting the open padlock icon  (or  if restrictions already apply). 

Formatting text with wiki markdown

JIRA application Text Formatting Notation allows you to use rich-text features, such as:

  • Italic, bold, underlined text
  • Multiple levels of headings
  • Bullets, numbered lists, tables, and quotations
  • Images
  • Macros

When you edit an issue description, comment, or any rich-text field, you can expand the simple wiki editor toolbar to format your text and select preview to see how your formatted text will appear. Note that your JIRA administrator can enable, disable and configure the renderer which allows you to use wiki markdown, so your options may vary slightly.

HTML macro

When using the HTML macro, which allow you to add HTML code to an issue, you should only use formatting as if you are including something inside the {{<body>}} directly. This prevents you from accidentally breaking the page formatting, or overriding JIRA's CSS.

Note that if you're administrator has enabled the rich text editor, you'll still be able to format your content using wiki markdown, but if you select the visual editor, you'll see the markdown applied directly.

Tracking issues with labels

Labeling helps you categorize and search for an issue. When viewing an issue, select More > Labels to add or remove labels, which will appear in the Details section:

You can click a label (e.g. doc in the above screenshot) to jump to the Issue Navigator and see a list of all issues that have this label. You can also add the Labels Gadget to your dashboard to quickly find issues with labels relevant to you and your team.

Watching and voting for issues

What permissions do you need?

To view other users watching or voting for an issue, you need the View Voters and Watchers and Manage Watcher List project permissions.

If your administrator has set up the needed notification scheme, you can select Start watching this issue to be automatically notified of issue updates. You can also click the number of watchers on the issue to add other JIRA users as watchers. 

If your administrator has enabled the voting on issues, you can select Vote for this issue to encourage the responsible team to resolve or complete the issue.

Reordering sub-tasks on an issue

If you've added sub-tasks to an issue, and need to reorder them, you can drag and drop them on the issue navigator view of the parent issue. If you're using a board in JIRA Software, you can also reorder the sub-tasks on the board view. However, these two methods are independent of each other. Reordering sub-tasks on the parent issue will not reorder tasks on an existing board, and vice-versa.

Last modified on Nov 15, 2017

Was this helpful?

Yes
No
Provide feedback about this article

Not finding the help you need?

Ask the community

Powered by Confluence and Scroll Viewport.