Add files, images, and other content to describe an issue
Once you've created an issue, it's important to add enough detail to it to make sure whoever's working on it can resolve it as quickly as possible. Images, files, diagrams, support tickets, and other details all help to provide a clear picture of the work that needs to be done.
As you'd expect, you can add content like images and files from your computer, but you can also source and update content from external services via Atlassian Marketplace apps. Here are a few common ways you can add content to issues to create a richer picture for whoever's working on it.
Add a description
A complete description on an issue can save a lot of time in the long run. If you or a teammate come to an issue, but don't really understand what it's all about once you're there, it can mean chasing down the creator and asking lots of questions. A good description means the assignee can start work straight away and get to done faster.
A description can include rich text, code snippets, images, tables, and more. The editor converts things like links, code, and markdown on-the-fly, so you can paste in your content and let the editor do the work.
The editor in the new issue view uses markdown rather than wiki markup. Right now, if you've added wiki markup in the old editor, we'll render it correctly in the new issue view. As we continue to roll out the new issue view and new editor, wiki markup support will be phased out and eventually removed in favor of markdown.
See Add files, images, and other content to describe an issue for tips on formatting content with markdown.
Mention your teammates
If you need someone to know about an issue, but you don't plan to assign it to them, you can mention them in it. Type @ followed by their name, then choose the right person from the list. The person you mention will be notified and can quickly jump to the issue to see what's happening.
To view a history of the changes made to an issue, click on the Comments drop-down menu at the bottom of the issue and choose History.
Attach files and images
To attach a file to an issue, open the issue and drop the file on it or choose the Add attachmentquick-add button at the top of the issue.
Connect your file storage services like Dropbox and Google Drive in the add attachment dialog to add your cloud-hosted files to issues.
Some considerations for attached files:
- File formats: GIF, JPG, and PNG.
- File names can't contain any of these characters:
'\', '/','\"', '%', ':', '$', '?', '*'.
By default, the maximum size of any one file is 10MB, but your Jira admin can change this limit.
There may be existing issues that relate to the one you're working on, and their details can help add more context. When you link two issues together, they each appear on the other's issue view below the issue description. Linking issues doesn't change the issues in any other way.
To link an issue:
- Open an issue and choose the Link issue icon
- Choose the relationship ("is blocked by" or "relates to," for example)
- Search for and select the issue to link
- Choose Link
- Quick add buttons: Use the icon to add a linked issue.
- Linked issues: See linked issues and their relationship to the issue you're viewing.
Add content from apps
Issue content helps describe an issue in ways a description and other details can't. If your Jira site has installed Atlassian Marketplace apps, you can add content via the quick-add buttons under the issue summary. Diagrams and charts are two common types of content that can help describe an issue, but there are many other options on the Marketplace.
To the right of the standard quick-add buttons for adding attachments, child issues, and linked issues, you'll find buttons for any installed apps you have permission to use. Click the quick-add button and follow any required steps to add your content.
Once you click the quick-add button, you can add content from the app to your issue. Here's an example of Google Drive content added to an issue. This way, you can ensure everyone's seeing the latest version of a file.
If you have permission to install apps on your site, you can use the ••• > Add more option to find and install apps to extend Jira's capabilities.