You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 02-labelling-strategy.Rmd
+36-27Lines changed: 36 additions & 27 deletions
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,10 @@
4
4
5
5
This documentation outlines the labelling strategy that was used for dealing with issues. It was inspired by [this](https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63) blog post. There are four types of categories used to label issues.
6
6
7
-
-Type
8
-
-Status
9
-
-Complexity
10
-
-Priority
7
+
- Type
8
+
- Status
9
+
- Complexity
10
+
- Priority
11
11
12
12
That may then look like this. 
13
13
@@ -22,49 +22,58 @@ In the next section, we will introduce every category in detail and descending o
22
22
23
23
Type describes the type of the issue, it can be one of the following:
24
24
25
-
- Bug: Everything ranging from unexpected behavior to faulty behavior.
26
-
- Enhancement: An issue that relates to adding a feature to the project that results in an API change.
27
-
- Infrastructure: Similar to Enhancement, but this refers to internal changes and re-factoring, maintenance etc. rather than to API changes that affect the user experience.
28
-
- User Question: Questions from users that are not really any of the above, but rather just need clarification on the project.
29
-
- Unassigned: No type assigned yet.
25
+
- Bug: Everything ranging from unexpected behavior to faulty behavior.
26
+
- Enhancement: An issue that relates to adding a feature to the project that
27
+
results in an API change.
28
+
- Infrastructure: Similar to Enhancement, but this refers to internal changes
29
+
and re-factoring, maintenance etc. rather than to API changes that affect the
30
+
user experience.
31
+
- User Question: Questions from users that are not really any of the above, but
32
+
rather just need clarification on the project.
33
+
- Unassigned: No type assigned yet.
30
34
31
35
## Status
32
36
33
-
34
37
Status describes the status of the issue, it can be one of the following:
35
38
36
-
- WIP: This is work in progress from some contributor and hence, it does not make sense for other people to also work on it.
37
-
- Postponed: The issue was postponed, so it should not be expected to be resolved in the near future. **Postponed issues are closed, even though they are not solved.**
38
-
- Unassigned: No status assigned yet.
39
+
- WIP: This is work in progress from some contributor and hence, it does not
40
+
make sense for other people to also work on it.
41
+
- Postponed: The issue was postponed, so it should not be expected to be
42
+
resolved in the near future. Reasons for an issue to get postponed might be
43
+
that the issue is blocked by some other issue or the lack
44
+
of time (from the developers side) to resolve it quickly given that there are
45
+
other (more urgent) issues.
46
+
**Postponed issues are closed, even though they are not solved.**
47
+
- Unassigned: No status assigned yet.
39
48
40
49
## Priority
41
50
42
51
43
52
Priority describes the relevance of the issue, it can be one of the following:
44
53
45
-
-Critical: This issue is really pressing and affects the functionality of the
46
-
project in a substantial fashion. It needs to be solved as soon as possible.
47
-
-High: Issue is urgent.
48
-
-Medium: Not so urgent.
49
-
-Low: This is a detail and does not affect the main functionality of the project.
50
-
-Unassigned: No priority assigned yet.
54
+
- Critical: This issue is really pressing and affects the functionality of the
55
+
project in a substantial fashion. It needs to be solved as soon as possible.
56
+
- High: Issue is urgent.
57
+
- Medium: Not so urgent.
58
+
- Low: This is a detail and does not affect the main functionality of the project.
59
+
- Unassigned: No priority assigned yet.
51
60
52
61
## Complexity
53
62
54
63
55
64
Complexity describes the complexity of the issue, it can be one of the following:
56
65
57
-
-High: Very complex issue that involves different aspects of the project that
58
-
need to be re-factored to solve the issue. Very time-consuming and difficult
59
-
to solve. Requires large background knowledge of the project.
60
-
-Medium: Might bear some complexity, time needed to solve this can be anticipated.
61
-
-Low: Almost trivial problem, can be resolved very quickly and without much
62
-
knowledge of the project.
63
-
-Unassigned: No complexity assigned yet.
66
+
- High: Very complex issue that involves different aspects of the project that
67
+
need to be re-factored to solve the issue. Very time-consuming and difficult
68
+
to solve. Requires large background knowledge of the project.
69
+
- Medium: Might bear some complexity, time needed to solve this can be anticipated.
70
+
- Low: Almost trivial problem, can be resolved very quickly and without much
71
+
knowledge of the project.
72
+
- Unassigned: No complexity assigned yet.
64
73
65
74
## Meta
66
75
67
76
68
77
Meta describes meta aspects of the issue, it can be one of the following:
0 commit comments