Skip to content

Commit 6cbb797

Browse files
Elaborate on reasons for "Status: Postponed".
1 parent 03596d4 commit 6cbb797

File tree

1 file changed

+36
-27
lines changed

1 file changed

+36
-27
lines changed

02-labelling-strategy.Rmd

Lines changed: 36 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
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.
66

7-
- Type
8-
- Status
9-
- Complexity
10-
- Priority
7+
- Type
8+
- Status
9+
- Complexity
10+
- Priority
1111

1212
That may then look like this. ![](pictures/gh-issues.png)
1313

@@ -22,49 +22,58 @@ In the next section, we will introduce every category in detail and descending o
2222

2323
Type describes the type of the issue, it can be one of the following:
2424

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.
3034

3135
## Status
3236

33-
3437
Status describes the status of the issue, it can be one of the following:
3538

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.
3948

4049
## Priority
4150

4251

4352
Priority describes the relevance of the issue, it can be one of the following:
4453

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.
5160

5261
## Complexity
5362

5463

5564
Complexity describes the complexity of the issue, it can be one of the following:
5665

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.
6473

6574
## Meta
6675

6776

6877
Meta describes meta aspects of the issue, it can be one of the following:
6978

70-
- Duplicate.
79+
- Duplicate.

0 commit comments

Comments
 (0)