| ... |
... |
@@ -25,15 +25,10 @@ and value all contributions to the project! |
|
25
|
25
|
|
|
26
|
26
|
### Milestones
|
|
27
|
27
|
|
|
28
|
|
-[Milestones](https://gitlab.com/groups/BuildStream/-/milestones) on Gitlab denote
|
|
29
|
|
-time-bound periods: we are using milestones to structure releases and events.
|
|
|
28
|
+We are using Gitlab's [Milestones](https://gitlab.com/groups/BuildStream/-/milestones)
|
|
|
29
|
+to help us structure and plan the content for releases and events.
|
|
30
|
30
|
See all group level milestones [here](https://gitlab.com/groups/BuildStream/-/milestones).
|
|
31
|
31
|
|
|
32
|
|
-Note: milestones are not to be confused with [Epics](https://docs.gitlab.com/ee/user/group/epics)
|
|
33
|
|
-which allow you to group sub tasks into an overall goal.
|
|
34
|
|
-Epics are currently not available for us to use in this version of Gitlab.
|
|
35
|
|
-
|
|
36
|
|
-
|
|
37
|
32
|
|
|
38
|
33
|
### Labels
|
|
39
|
34
|
|
| ... |
... |
@@ -41,35 +36,38 @@ Epics are currently not available for us to use in this version of Gitlab. |
|
41
|
36
|
filter tickets (ie, 'issues' in Gitlab terminology) in useful ways.
|
|
42
|
37
|
|
|
43
|
38
|
Labels add complexity and effort as they grow in number, so the ideal approach
|
|
44
|
|
- is to have the minimum possible but to use them consistently. Sadly, we currenlty have
|
|
45
|
|
- far too many labels, so if you want to add a new one, please do discuss this the [mailing
|
|
|
39
|
+ is to have the minimum possible but to use them consistently. Sadly, we currently have
|
|
|
40
|
+ far too many labels, so if you want to add a new one, please discuss this on the [mailing
|
|
46
|
41
|
list](https://mail.gnome.org/mailman/listinfo/buildstream-list) first.
|
|
47
|
42
|
|
|
48
|
|
-We have both [global scale labels](https://gitlab.com/groups/BuildStream/-/labels) and
|
|
|
43
|
+We have both [group level labels](https://gitlab.com/groups/BuildStream/-/labels) and
|
|
49
|
44
|
[BuildStream project specific labels](https://gitlab.com/BuildStream/buildstream/labels).
|
|
50
|
45
|
|
|
51
|
|
-When raising an issue, please consider which labels are appropriate:
|
|
|
46
|
+When raising an issue, please consider which labels are appropriate. We have the following labels:
|
|
52
|
47
|
|
|
53
|
|
-* Topic labels: each repository has its own labels that allow you to structure tickets per topic. For example, there's a 'Documentation' label for tasks related to documentation.
|
|
|
48
|
+* Topic labels: mainly used for tasks rather than bugs. Each repository has its own labels that allow you to structure tickets per topic. For example, there's a 'Documentation' label for tasks related to documentation.
|
|
54
|
49
|
|
|
55
|
|
-* Severity scale: please apply the below in order to get the attention of the core development team, as these labels are prioritized in weekly meetings:
|
|
|
50
|
+* Impact scale: Please apply the below if the bug/feature/task has a high impact on you as a user - this will be evaluated by the core development team and may be modified.
|
|
|
51
|
+ * No label: the bug/feature/task is infrequent or hard to reproduce and the impact on the users is low or hard to determine.
|
|
|
52
|
+ * High Impact: the bug/feature/task takes place frequently or is a recurrent one and has a significant impact on users everyday or key work.
|
|
|
53
|
+
|
|
|
54
|
+* Status scale: please see below re the Gitlab Issue Boards.
|
|
|
55
|
+
|
|
|
56
|
+* Severity scale: please do *not* worry about assigning these labels - all tickets are processed by the core development team [on a weekly basis](https://mail.gnome.org/archives/buildstream-list/2018-October/msg00064.html) and they will apply the below labels in order to prioritize.
|
|
56
|
57
|
* No label: unprocessed item, no or low priority.
|
|
57
|
58
|
* Important: default severity for processed items that should be executed/considered.
|
|
58
|
59
|
* Urgent: to pay attention in the immediate future when possible.
|
|
59
|
60
|
* Critical: topics that require attention immediately when possible.
|
|
60
|
|
-
|
|
61
|
|
-
|
|
62
|
|
-
|
|
63
|
61
|
|
|
64
|
62
|
### Issue Boards
|
|
65
|
63
|
|
|
66
|
64
|
[Issue boards](https://docs.gitlab.com/ee/user/project/issue_board.html) allow anybody interested in BuildStream to visualise and manage issues in a simple way.
|
|
67
|
|
-There are [Global level boards](https://gitlab.com/groups/BuildStream/-/boards/580444?milestone_title=BuildStream_v1.1>&=) and
|
|
68
|
|
-[BuildStream project specific boards](https://gitlab.com/BuildStream/buildstream/boards/580451?milestone_title=BuildStream_v1.1>&=).
|
|
69
|
|
-There is a drop down menu allowing you to select every available board. The most relevant to most people is the [Status-All Board](https://gitlab.com/BuildStream/buildstream/boards/134373).
|
|
|
65
|
+See the
|
|
|
66
|
+[BuildStream project specific boards](https://gitlab.com/BuildStream/buildstream/boards/580451?milestone_title=BuildStream_v1.1>&=) for details.
|
|
|
67
|
+There is a drop down menu allowing you to select every available board. For a view of the currently WIP items see the [Status-All Board](https://gitlab.com/BuildStream/buildstream/boards/134373).
|
|
70
|
68
|
|
|
71
|
69
|
Issues start life in the ``Backlog`` column by default, and we move them into
|
|
72
|
|
- ``ToDo`` when we aim to complete them soon. ``Doing`` is only for when an item is
|
|
|
70
|
+ ``ToDo`` when it is agreed that the work should be done. ``Doing`` is only for when an item is
|
|
73
|
71
|
currently being worked on. When on the Board view, dragging and dropping an issue from
|
|
74
|
72
|
column to column automatically adjusts the relevant labels.
|
|
75
|
73
|
|
| ... |
... |
@@ -102,9 +100,7 @@ We have two templates for issues: |
|
102
|
100
|
- If you plan to work on an issue, please:
|
|
103
|
101
|
|
|
104
|
102
|
- self-assign the ticket
|
|
105
|
|
- - ensure the ticket is in the ``ToDo`` column of the [Status-All Board](https://gitlab.com/BuildStream/buildstream/boards/134373) if you aim to
|
|
106
|
|
- work on it soon but are not yet working on it, and
|
|
107
|
|
- the ``Doing`` column if you are working on it currently.
|
|
|
103
|
+ - ensure the ticket is in the ``Doing`` column of the [Status-All Board](https://gitlab.com/BuildStream/buildstream/boards/134373) if you are working on it.
|
|
108
|
104
|
|
|
109
|
105
|
- Please note that Gitlab issues are for either 'tasks' or 'bugs' - ie not for
|
|
110
|
106
|
long discussions (where the mailing list is a better choice) or for ranting,
|
| ... |
... |
@@ -112,12 +108,16 @@ We have two templates for issues: |
|
112
|
108
|
|
|
113
|
109
|
|
|
114
|
110
|
## Roadmap policies
|
|
|
111
|
+
|
|
|
112
|
+Coming soon...
|
|
115
|
113
|
|
|
116
|
|
-## Suggest improvements or additions to the BuildStream policy
|
|
|
114
|
+## Suggest improvements or additions to BuildStream policies
|
|
|
115
|
+
|
|
|
116
|
+For any suggestions related to policies for hacking on BuildStream code, please submit an MR to [CONTRIBUTING.rst](https://gitlab.com/BuildStream/buildstream/blob/master/CONTRIBUTING.rst).
|
|
117
|
117
|
|
|
118
|
|
-If the suggestion refers to coding or hacking the BuildStream code related policies, please create a MR to the technical documentation: <https://gitlab.com/BuildStream/buildstream/tree/master/doc/source>
|
|
|
118
|
+If the suggestion refers to how to manage tickets, bugs or merge requests or any other topic not directly related with coding, please create a MR to this policy instead of editing this wiki page.
|
|
119
|
119
|
|
|
120
|
|
-If the suggestion refers to how to manage tickets, bugs or merge requests or any other topic not directly related with coding, please create a MR to this policy instead of editing this wiki page: <https://gitlab.com/BuildStream/nosoftware/alignment/blob/master/BuildStream_policies.md>
|
|
|
120
|
+Or, alternatively, please always free to send any proposal to the mailing list:
|
|
121
|
121
|
|
|
122
|
|
-You can always send the proposal to the <mailto:buildstream-list gnome org> mailing list if any of the options above fits or you are unsure about what to do.
|
|
|
122
|
+ <mailto:buildstream-list gnome org>
|
|
123
|
123
|
|
