RedmineIssues » History » Version 28

Joel Bearden, 2011-08-31 14:06

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 26 Kevin Thompson
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, starting from the oldest to the newest message. 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 25 Etienne Massip
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 25 Etienne Massip
* *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 1 Thomas Lecavelier
* *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 25 Etienne Massip
* *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 25 Etienne Massip
* *follows* - Reciprocal of precedes
39 25 Etienne Massip
     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 1 Thomas Lecavelier
43 25 Etienne Massip
!redmine-related-issues.png!
44 1 Thomas Lecavelier
45 25 Etienne Massip
Administrators can define the [[RedmineRoles#Permissions|permissions]] of users to add and edit such relations.
46 1 Thomas Lecavelier
47 25 Etienne Massip
h3. Watchers
48 25 Etienne Massip
49 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.
50 25 Etienne Massip
51 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.
52 25 Etienne Massip
53 25 Etienne Massip
!redmine-watchers.png!
54 25 Etienne Massip
55 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.
56 25 Etienne Massip
57 25 Etienne Massip
h3. Associated revisions
58 25 Etienne Massip
59 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).
60 25 Etienne Massip
61 25 Etienne Massip
!redmine-associated-revision.png!
62 25 Etienne Massip
63 25 Etienne Massip
h2. Adding a new issue
64 25 Etienne Massip
65 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]]).
66 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_.
67 25 Etienne Massip
68 25 Etienne Massip
h2. Updating an existing issue
69 25 Etienne Massip
70 25 Etienne Massip
(TODO: describe and upload a screen-shot of update panel)
71 25 Etienne Massip
72 25 Etienne Massip
To edit the issue, Click _Update_ link (having a pencil icon) at the top or the bottom of the issue page:
73 25 Etienne Massip
74 25 Etienne Massip
!RedmineEditIssue_Update_Link.png!
75 25 Etienne Massip
76 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.
77 25 Etienne Massip
78 25 Etienne Massip
79 25 Etienne Massip
h2. Editing an existing issue's Subject or Description
80 25 Etienne Massip
81 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. 
82 25 Etienne Massip
This right gives you a _(More)_ link after the Change Properties section title in the "Update issue" panel.
83 25 Etienne Massip
84 25 Etienne Massip
# Open the issue
85 25 Etienne Massip
# Click _Update_ link (having a pen icon) at the top or the bottom of the issue page. 
86 25 Etienne Massip
# See *Change properties* dialog with the _(More)_ link (see a screenshot below).
87 25 Etienne Massip
# Clicking on the _(More)_ link will bring-up an editable copy of the Subject and Description of the issue.
88 25 Etienne Massip
89 25 Etienne Massip
p=. !RedmineEditIssue_More_Link_new_location.png!
90 25 Etienne Massip
91 25 Etienne Massip
h2. Subtasks
92 25 Etienne Massip
93 25 Etienne Massip
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.
94 25 Etienne Massip
Subtask related changes for Parent issues are made in r3617, r3671, r3821 and r3869.
95 25 Etienne Massip
96 25 Etienne Massip
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.
97 25 Etienne Massip
98 25 Etienne Massip
TODO, extend (please keep the revision info above for referencing while this TODO is current).