RedmineIssues » History » Version 47

Go MAEDA, 2018-12-27 00:44
Fixed typos

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 47 Go MAEDA
In order to edit an existing issue, your role has to have the [[RedmineRoles#Permissions|Issue Tracking > Edit Issues]] right in the [[RedmineRoles|roles and permissions]] configuration. 
88 25 Etienne Massip
89 25 Etienne Massip
# Open the issue
90 1 Thomas Lecavelier
# Click _Update_ link (having a pen icon) at the top or the bottom of the issue page. 
91 43 Toshi MARUYAMA
92 43 Toshi MARUYAMA
The description of the issue has pencil icon right next to it that you can click to change the description.
93 43 Toshi MARUYAMA
94 43 Toshi MARUYAMA
p=. !RedmineChangingIssueDescriptionNew.png!
95 43 Toshi MARUYAMA
96 30 Raghu Govindarajan
97 25 Etienne Massip
h2. Subtasks
98 25 Etienne Massip
99 47 Go MAEDA
Sometimes it is useful to break huge tasks down into smaller subtasks to have more control over the task or to assign smaller parts of it to different users. One can create a subtask by either clicking the 'Add' link in the subtasks section of the parent task or by filling the parents task id into the 'parents task' field of the subtask. This is also possible after creation by [[RedmineIssues#Updating-an-existing-issue|updating the task]]. Because it's just a normal task a subtask can also have subtasks. There is no limit in the depth of this stack.
100 1 Thomas Lecavelier
101 45 Bernhard Rohloff
Subtasks can belong to a different project than the parent task. This functionality is configurable in the [[RedmineSettings#Allow-cross-project-subtasks|settings section]] in the administration menu. Defining subtasks requires the permission 'Manage subtasks' which can be set in the [[RedmineRoles|roles and permissions section]] in the administration menu.
102 45 Bernhard Rohloff
If a project gets copied the whole tree beneath the parent task is copied, too. When copying only the parent task one can choose if the subtasks should also be copied.
103 45 Bernhard Rohloff
104 45 Bernhard Rohloff
h3. Filtering & sorting
105 45 Bernhard Rohloff
106 47 Go MAEDA
One can show the parents task id as sortable column in the issues list and there is also a filter option for it.
107 47 Go MAEDA
When the list is sorted by the parent task id the subtasks hierarchy is displayed in an indented tree structure.
108 45 Bernhard Rohloff
!subtasks-list.png!
109 45 Bernhard Rohloff
110 45 Bernhard Rohloff
As long as the tasks share the same target version the tree structure is also visible in the gantt view.
111 45 Bernhard Rohloff
!subtasks-gantt.png!
112 45 Bernhard Rohloff
  
113 45 Bernhard Rohloff
h3. Relations between the parent task and its subtasks
114 45 Bernhard Rohloff
115 45 Bernhard Rohloff
Some properties of the parent task are influenced by the subtasks underneath.
116 45 Bernhard Rohloff
The following relations exist between the parent task and its subtasks.
117 45 Bernhard Rohloff
118 36 Scott Macpherson
* The parent task's done percentage is the weighted average ratio of subtasks.
119 37 Javi Ferrer
* The parent task's start is the lowest date of subtasks.
120 38 Javi Ferrer
* The parent task's due date is the highest due date of subtasks.
121 39 Javi Ferrer
* The parent task's spent time is the sum of the subtasks' spent times.
122 36 Scott Macpherson
* The parent task's estimation time is the sum of the subtasks' estimation times.
123 47 Go MAEDA
* The parent task's priority is the highest of the subtasks' priorities.
124 45 Bernhard Rohloff
* Subtasks are rescheduled when a 'precedes' relation is set on a parent task.