For an issue tracker, the main reason for its existence is an issue. That's what issue trackers are about: reporting issues, searching for them, working with them. Though depending on your team and goals, an issue might represent different things — bugs, tasks, defects, etc. — in the end it is all about issues.
This tutorial will help you make the first step — report an issue in your tracker. In YouTrack we did our best to make reporting issue fast and easy, while preserving all the options you need to easily complete your daily tracking activities.
Here we will cover the following options:
The first use case that we are going to cover is the quickest way to report a new issue. Well, it actually takes two hotkeys:
- Press Alt+Insert or Ctrl+N on Mac OS
- Select project, write issue's summary and, optionally, its short description.
- Press Ctrl+Enter to submit.
Literally, it is easy as one-two-three. Now, let's make the next step and dive into more details. Indeed, summary and description are not always enough. You can edit the reported issues, or you can create an issue with all the details you need.
To create a new issue from within YouTrack:
- In YouTrack, press Alt+Ins (or Ctrl+N if you work with Mac) or click the Create Issue button in the main top toolbar to open the New Issue dialog:
- Select a project to report an issue to.
- Write issue's summary and description. By the way, you can use special wiki syntax to format your description. You can view detailed syntax reference: Click the wiki markup link there, just above the description field.
- Specify issue attributes (for example, Type, Priority, Subsystem etc.) by either of the followings:
- With attribute fields in the side panel.
- Press Ctrl+Alt+J to call the Command window and specify any attributes in a single command.
- To attach an image or a file to the new issue, just drop them on the issue's main area. Or, click the clip button in the toolbar and choose any of the options that it provides.
- When you finish configuring the new issue, press Ctrl+Enter or click Create Issue. And it's done!
If you are not ready yet to report the issue, you do not have to worry about loosing all the work you just did. Save the draft, and finish reporting the issue later. And this brings us to the next step and section of this tutorial.
While you are configuring parameters of a new issue as described above, YouTrack saves this data automatically, as the issue draft. Basically, to save the draft you just don't need to do anything specific. You can close the new issue dialog, or leave it 'as is' whenever you need: Just click Close to exit 'New Issue* dialog or click the Create another issue link to start reporting another issue.
The next time you open the new issue dialog you can choose a previously saved draft to continue creating an issue when you will find the latest auto-saved draft open and you can continue where you stopped. Just click the <N drafts> link and select any of the previously saved drafts:
What you do have to keep in mind if you want the issue draft be saved is do not click Reset Draft link. When you click 'Reset Draft', all issue parameters are cleared to their default values and the draft is deleted.
Issue drafts save your work and time, but what can make your routine a bit easier still is Issue Template.
YouTrack provides you with an option to generate an URL which will call the New Issue dialog with already pre-set parameters. You can send this URL to your customers or collaborators, or provide it on your site for the users to report feedback or issues. You also can use this link yourself for further issues reporting. When the link is clicked, the New Issue dialog opens with all issue attributes, that had been set on the moment of the creating the URL, filled in.
When you create a new issue, below the main issue area you will find the Generate issue template URL link.
All you need to do to create a template is follow these simple steps:
- Click Create Issue to open the New Issue dialog.
- Set the fields which you want to be filled-in in the new issues.
- Click Generate issue template URL link.
In the displayed field you will see the generated URL. Just copy it and share by any means you like.
For example, you have set Project, Type, Subsystem and Assignee for the new issue and generated the URL:
For the example on the screenshot, the generated URL for the new issue template will look as follows:
When anyone uses this generated link, the Create Issue dialog will be opened, and Project, Type, Assignee, and Subsystem will be set to the same values that you set in the original new issue. Other parameters will be shown with default system values.
As you see, YouTrack does its best to make your daily routine optimized, and the last section is about small but very useful thing: YouTrack Bookmarklet.
The bookmarklet is a tiny applet for a browser that allows you to submit new issues in YouTrack without changing the context you are working in. That is:The bookmarklet will let you report a new issue without opening YouTrack or even switching between browser tabs or windows.
Bookmarklet supports all most important options of the standard New Issue dialog:
- Specifying any issue attribute
- Adding attachments
- Taking a screenshot and adding it to new issue
To install the bookmarklet, drag-n-drop to your browser's toolbar the highlighted Create Issue link from any of the following pages of your issue tracker:
- Create New Issue dialog
- Help -> Shortcuts window.
If you use MS Internet Explorer, you can't use bookmarklet as the toolbar's button, but you can add the link to your Favorites.
When you have the bookmarklet installed, you can create a new issue like this:
- Invoke bookmarklet in your browser:
- Select a project to create new issue in.
- Specify issue's summary and all the necessary attributes.
- If needed, add an attachment or a screenshot.
- Click Submit to report the new issue.
We hope you find this tutorial useful.
Submit Issues with Pleasure!
Your YouTrack Team