RedmineIssues » History » Version 42

Matt Wiseley, 2014-12-19 02:40
Remove subtask TODO documentation for all previously referenced issues now exists here; Added Gantt chart display of subtasks

1 1 Thomas Lecavelier
h1. Issue Tracking 
2 1 Thomas Lecavelier
3 23 Beni Chan
4 18 Mischa The Evil
{{>toc}}
5 18 Mischa The Evil
6 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.
7 1 Thomas Lecavelier
8 7 Tom Rochette
h2. Listing of the issue
9 7 Tom Rochette
10 33 dj jones
From a selected issue page, you can see the work in progress that is done to fix the issue. The messages are displayed in chronological order, (to change the order - see the setting in 'My Accounts'). It is possible to quote others' messages as well as to edit yours.
11 7 Tom Rochette
12 25 Etienne Massip
h3. Related issues
13 9 Tom Rochette
14 34 dj jones
'Related issues' allow developers to link issues to each other in order to remove duplicates or simplify their workflow.
15 1 Thomas Lecavelier
16 25 Etienne Massip
It is possible to link issues based on various relations. Current relations are:
17 40 @ go2null
* *related to* - Just adds a link to the other issue.
18 1 Thomas Lecavelier
19 25 Etienne Massip
* *duplicates* - Links issues so that closing one, will close the other (e.g. closing A will close B)
20 28 Joel Bearden
     For example, if issue B *duplicates* A:
21 27 Joel Bearden
     - closing B will leave A open
22 27 Joel Bearden
     - closing A will automatically close B
23 27 Joel Bearden
24 40 @ go2null
* *duplicated by* - Reciprocal of _duplicates_.
25 28 Joel Bearden
     For example, if issue A is *duplicated by* issue B:
26 27 Joel Bearden
     - closing B will leave A open
27 27 Joel Bearden
     - closing A will automatically close B
28 1 Thomas Lecavelier
29 25 Etienne Massip
* *blocks* - Links issues so that closing one can be blocked by an issue which is still open
30 25 Etienne Massip
     If issue B blocks A,
31 25 Etienne Massip
     A can't be closed unless B is.
32 40 @ go2null
* *blocked by* - Reciprocal of _blocks_.
33 1 Thomas Lecavelier
34 25 Etienne Massip
* *precedes* - Links issues to define an "order", where A needs to be completed x days before B can be started on
35 25 Etienne Massip
     If B follows A, you can't give B
36 25 Etienne Massip
     a starting date equal or less
37 25 Etienne Massip
     than the ending date of A.
38 40 @ go2null
* *follows* - Reciprocal of _precedes_.
39 1 Thomas Lecavelier
     If issue B follows A (ex A ends the 21/04 and B begins the 22/04)
40 25 Etienne Massip
     and you add +2 day at the ending date of A,
41 25 Etienne Massip
     the starting and ending dates of B will be +2 too.
42 41 @ go2null
43 40 @ go2null
* *copied from* - Links issues to identify whether it was copied, and from which issue it was copied from.
44 40 @ go2null
* *copied to* - Reciprocal of _copied from_.
45 1 Thomas Lecavelier
46 25 Etienne Massip
!redmine-related-issues.png!
47 1 Thomas Lecavelier
48 25 Etienne Massip
Administrators can define the [[RedmineRoles#Permissions|permissions]] of users to add and edit such relations.
49 1 Thomas Lecavelier
50 25 Etienne Massip
h3. Watchers
51 25 Etienne Massip
52 25 Etienne Massip
Display a list of all the users who are watching this issue. If the issue is updated, those users will be notified.
53 25 Etienne Massip
54 25 Etienne Massip
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.
55 25 Etienne Massip
56 25 Etienne Massip
!redmine-watchers.png!
57 25 Etienne Massip
58 25 Etienne Massip
Administrators can define the [[RedmineRoles#Permissions|permissions]] of users to add/delete watchers as well as to see the list of watchers.
59 25 Etienne Massip
60 25 Etienne Massip
h3. Associated revisions
61 25 Etienne Massip
62 25 Etienne Massip
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).
63 25 Etienne Massip
64 25 Etienne Massip
!redmine-associated-revision.png!
65 25 Etienne Massip
66 31 C Tibirna
Revisions can also be associated to issues manually, from a changeset (revision) view in the Repository browser. The manual associations are reversible. They can be revoked by using the broken chain icon to the right of an added association, again in the changeset view.
67 31 C Tibirna
68 31 C Tibirna
!redmine_manual_revision_issue_association.png!
69 31 C Tibirna
70 25 Etienne Massip
h2. Adding a new issue
71 25 Etienne Massip
72 25 Etienne Massip
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]]).
73 25 Etienne Massip
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_.
74 25 Etienne Massip
75 25 Etienne Massip
h2. Updating an existing issue
76 25 Etienne Massip
77 25 Etienne Massip
(TODO: describe and upload a screen-shot of update panel)
78 25 Etienne Massip
79 25 Etienne Massip
To edit the issue, Click _Update_ link (having a pencil icon) at the top or the bottom of the issue page:
80 25 Etienne Massip
81 25 Etienne Massip
!RedmineEditIssue_Update_Link.png!
82 25 Etienne Massip
83 25 Etienne Massip
Depending you your role permissions (see [[RedmineRoles|roles and permissions]]), you will see a complete or a limited set of editable issue properties.
84 25 Etienne Massip
85 25 Etienne Massip
h2. Editing an existing issue's Subject or Description
86 25 Etienne Massip
87 26 Kevin Thompson
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]] configuration. 
88 25 Etienne Massip
This right gives you a _(More)_ link after the Change Properties section title in the "Update issue" panel.
89 25 Etienne Massip
90 25 Etienne Massip
# Open the issue
91 25 Etienne Massip
# Click _Update_ link (having a pen icon) at the top or the bottom of the issue page. 
92 25 Etienne Massip
# See *Change properties* dialog with the _(More)_ link (see a screenshot below).
93 25 Etienne Massip
# Clicking on the _(More)_ link will bring-up an editable copy of the Subject and Description of the issue.
94 25 Etienne Massip
95 1 Thomas Lecavelier
p=. !RedmineEditIssue_More_Link_new_location.png!
96 29 Raghu Govindarajan
97 29 Raghu Govindarajan
For version 2.0 onwards, the _(More)_ link does not exist any more. Instead the subject line is editable by default. The description of the issue has pencil icon right next to it that you can click to change the description.
98 29 Raghu Govindarajan
99 30 Raghu Govindarajan
p=. !RedmineChangingIssueDescriptionNew.png!
100 25 Etienne Massip
101 25 Etienne Massip
h2. Subtasks
102 25 Etienne Massip
103 42 Matt Wiseley
You can [[RedmineIssues#Updating-an-existing-issue|update an issue]] 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.
104 25 Etienne Massip
105 1 Thomas Lecavelier
* Subtasks can belong to a different project than the parent task, dependent on the configuration switch in admin settings.
106 36 Scott Macpherson
* Subtasks are rescheduled when a 'precedes' relation is set on a parent task.
107 36 Scott Macpherson
* The parent task is available as a column in issues list for sorting and filtering.
108 42 Matt Wiseley
* The parent subtasks issue hierarchy is displayed in issues when list is sorted by parent and also in the Gantt chart.
109 36 Scott Macpherson
* Descendant issues are displayed in a tree on the issue view with context menu support.
110 36 Scott Macpherson
* The parents subtasks issue tree is also copied on project copy.
111 36 Scott Macpherson
* Subtasks feature allows unlimited nesting.
112 36 Scott Macpherson
* Defining subtasks requires the new permission 'Manage subtasks'.
113 37 redmineservices .
* The parent task's done percentage is the weighted average ratio of subtasks.
114 38 redmineservices .
* The parent task's start is the lowest date of subtasks.
115 39 redmineservices .
* The parent task's due date is the highest due date of subtasks.
116 36 Scott Macpherson
* The parent task's spent time is the sum of the subtasks' spent times.
117 32 Terence Mill
* The parent task's estimation time is the sum of the subtasks' estimation times.
118 25 Etienne Massip
* The parent task's priority is the highest of the subtasks' priorties.