RedmineIssues » History » Version 22

Dave Clements, 2011-01-24 19:44
"pen icon" -> "pencil icon"

1 1 Thomas Lecavelier
h1. Issue Tracking 
2 1 Thomas Lecavelier
3 18 Mischa The Evil
4 18 Mischa The Evil
5 3 Mischa The Evil
Issues are the heart of the Redmine business. An issue is bound to a project, owned by a user, can be related to a version, etc.
6 1 Thomas Lecavelier
7 7 Tom Rochette
h2. Listing of the issue
8 7 Tom Rochette
9 7 Tom Rochette
From a selected issue page, you can see the work in progress that is done to fix the issue. The messages are displayed in chroonological order, starting from the oldest to the newest message. It is possible to quote others' messages as well as to edit yours.
10 7 Tom Rochette
11 9 Tom Rochette
h3. Related issues
12 9 Tom Rochette
13 9 Tom Rochette
Related issues allow developers to link issues to each other in order to remove duplicates or simplify their workflow.
14 9 Tom Rochette
15 9 Tom Rochette
It is possible to link issues based on various relations. Current relations are:
16 19 Mischa The Evil
* *related to* - Just adds a link to the other issue
17 19 Mischa The Evil
18 19 Mischa The Evil
* *duplicates* - Links issues so that closing one, will close the other (e.g. closing A will close B)
19 1 Thomas Lecavelier
     If issue B is the duplicate of A
20 1 Thomas Lecavelier
     - closing B will let A open
21 1 Thomas Lecavelier
     - closing A will close B
22 19 Mischa The Evil
* *duplicated by* - Reciprocal of duplicates
23 19 Mischa The Evil
24 19 Mischa The Evil
* *blocks* - Links issues so that closing one can be blocked by an issue which is still open
25 1 Thomas Lecavelier
     If issue B blocks A,
26 12 Brice P
     A can't be closed unless B is.
27 19 Mischa The Evil
* *blocked by* - Reciprocal of blocks
28 19 Mischa The Evil
29 19 Mischa The Evil
* *precedes* - Links issues to define an "order", where A needs to be completed x days before B can be started on
30 1 Thomas Lecavelier
     If B follows A, you can't give B
31 13 Brice P
     a starting date equal or less
32 13 Brice P
     than the ending date of A.
33 19 Mischa The Evil
* *follows* - Reciprocal of precedes
34 12 Brice P
     If issue B follows A (ex A ends the 21/04 and B begins the 22/04)
35 11 Brice P
     and you add +2 day at the ending date of A,
36 20 Mischa The Evil
     the starting and ending dates of B will be +2 too.
37 9 Tom Rochette
38 9 Tom Rochette
39 9 Tom Rochette
40 10 Tom Rochette
Administrators can define the [[RedmineRoles#Permissions|permissions]] of users to add and edit such relations.
41 10 Tom Rochette
42 9 Tom Rochette
h3. Watchers
43 9 Tom Rochette
44 9 Tom Rochette
Display a list of all the users who are watching this issue. If the issue is updated, those users will be notified.
45 9 Tom Rochette
46 9 Tom Rochette
If you are logged in as a project administrator, it is possible for you to add users to the watch list on this page. By clicking on the Add link, a drop-down menu with a *Add* button appear, which allows you to select which user to add to the watch list.
47 9 Tom Rochette
48 9 Tom Rochette
49 10 Tom Rochette
50 10 Tom Rochette
Administrators can define the [[RedmineRoles#Permissions|permissions]] of users to add/delete watchers as well as to see the list of watchers.
51 9 Tom Rochette
52 7 Tom Rochette
h3. Associated revisions
53 7 Tom Rochette
54 8 Tom Rochette
If the administrator has defined [[RedmineSettings#Referencing-issues-in-commit-messages|Referencing Issues Keywords]], a developer that uses such keyword(s) will see its commit message displayed on the issue page, under the Associated revisions block (generally to the right of the first reply).
55 7 Tom Rochette
56 7 Tom Rochette
57 7 Tom Rochette
58 1 Thomas Lecavelier
h2. Adding a new issue
59 1 Thomas Lecavelier
60 6 Tom Rochette
People can create a new issue when they meet the [[RedmineRoles|roles and permissions]] configured by the Redmine Administrator ([[RedmineRoles#Permissions|Role: Issue Tracking > Add Issues]]).
61 4 Mischa The Evil
When creating a new issue, one of the most important items is the [[RedmineIssueTrackingSetup#Trackers|tracker field]], which defines the nature of the issue. By default, Redmine comes with three different trackers: _bug_, _feature_, and _support_.
62 1 Thomas Lecavelier
63 1 Thomas Lecavelier
h2. Updating an existing issue
64 1 Thomas Lecavelier
65 1 Thomas Lecavelier
(TODO: describe and upload a screen-shot of update panel)
66 1 Thomas Lecavelier
67 22 Dave Clements
To edit the issue, Click _Update_ link (having a pencil icon) at the top or the bottom of the issue page:
68 15 Tatiana Tvardovskaya
69 15 Tatiana Tvardovskaya
70 15 Tatiana Tvardovskaya
71 15 Tatiana Tvardovskaya
Depending you your role permissions (see [[RedmineRoles|roles and permissions]]), you will see a complete or a limited set of editable issue properties.
72 15 Tatiana Tvardovskaya
73 14 Tatiana Tvardovskaya
74 17 Tatiana Tvardovskaya
h2. Editing an existing issue's Subject or Description
75 1 Thomas Lecavelier
76 14 Tatiana Tvardovskaya
In order to edit an existing issue, your role has to have the [[RedmineRoles#Permissions|Issue Tracking > Edit Issues]] right in the the [[RedmineRoles|roles and permissions]] configation. 
77 14 Tatiana Tvardovskaya
This right gives you a _(More)_ link after the Change Properties section title in the "Update issue" panel.
78 1 Thomas Lecavelier
79 14 Tatiana Tvardovskaya
# Open the issue
80 14 Tatiana Tvardovskaya
# Click _Update_ link (having a pen icon) at the top or the bottom of the issue page. 
81 14 Tatiana Tvardovskaya
# See *Change properties* dialog with the _(More)_ link (see a screenshot below).
82 14 Tatiana Tvardovskaya
# Clicking on the _(More)_ link will bring-up an editable copy of the Subject and Description of the issue.
83 2 Thomas Lecavelier
84 14 Tatiana Tvardovskaya
p=. !RedmineEditIssue_More_Link_new_location.png!
85 21 Mischa The Evil
86 21 Mischa The Evil
h2. Subtasks
87 21 Mischa The Evil
88 21 Mischa The Evil
Subtasks (#443) are introduced in Redmine version#14. They are integrated in r3573, r3574, r3576, r3577 and refined in r3618. They are fixed in r3593, r3633, r3677 and r4061.
89 21 Mischa The Evil
Subtask related changes for Parent issues are made in r3617, r3671, r3821 and r3869.
90 21 Mischa The Evil
91 21 Mischa The Evil
You can [[RedmineIssues#Updating-an-existing-issue|update an issue]] and access the [[RedmineIssues#Editing-an-existing-issues-Subject-or-Description|"More"-link]] to (re)set the "Parent task" field. This can be used to "convert" a normal issue into a subtask, move a subtask from one parent to another, or convert a subtask to a normal issue.
92 21 Mischa The Evil
93 21 Mischa The Evil
TODO, extend (please keep the revision info above for referencing while this TODO is current).