Project

General

Profile

RedmineIssues » History » Version 30

Raghu Govindarajan, 2012-07-13 19:30

1 1 Thomas Lecavelier
h1. Issue Tracking 
2
3 23 Beni Chan
4 18 Mischa The Evil
{{>toc}}
5
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
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
* *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
     - closing A will automatically close B
23
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
     - 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
     If issue B blocks A,
31
     A can't be closed unless B is.
32
* *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
     If B follows A, you can't give B
36
     a starting date equal or less
37
     than the ending date of A.
38
* *follows* - Reciprocal of precedes
39
     If issue B follows A (ex A ends the 21/04 and B begins the 22/04)
40
     and you add +2 day at the ending date of A,
41
     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
49
Display a list of all the users who are watching this issue. If the issue is updated, those users will be notified.
50
51
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
53
!redmine-watchers.png!
54
55
Administrators can define the [[RedmineRoles#Permissions|permissions]] of users to add/delete watchers as well as to see the list of watchers.
56
57
h3. Associated revisions
58
59
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
61
!redmine-associated-revision.png!
62
63
h2. Adding a new issue
64
65
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
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
68
h2. Updating an existing issue
69
70
(TODO: describe and upload a screen-shot of update panel)
71
72
To edit the issue, Click _Update_ link (having a pencil icon) at the top or the bottom of the issue page:
73
74
!RedmineEditIssue_Update_Link.png!
75
76
Depending you your role permissions (see [[RedmineRoles|roles and permissions]]), you will see a complete or a limited set of editable issue properties.
77
78
h2. Editing an existing issue's Subject or Description
79
80 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. 
81 25 Etienne Massip
This right gives you a _(More)_ link after the Change Properties section title in the "Update issue" panel.
82
83
# Open the issue
84
# Click _Update_ link (having a pen icon) at the top or the bottom of the issue page. 
85
# See *Change properties* dialog with the _(More)_ link (see a screenshot below).
86
# Clicking on the _(More)_ link will bring-up an editable copy of the Subject and Description of the issue.
87
88 1 Thomas Lecavelier
p=. !RedmineEditIssue_More_Link_new_location.png!
89 29 Raghu Govindarajan
90
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.
91
92 30 Raghu Govindarajan
p=. !RedmineChangingIssueDescriptionNew.png!
93 25 Etienne Massip
94
h2. Subtasks
95
96
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.
97
Subtask related changes for Parent issues are made in r3617, r3671, r3821 and r3869.
98
99
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.
100
101
TODO, extend (please keep the revision info above for referencing while this TODO is current).