| ... |
... |
@@ -237,21 +237,49 @@ following goals: |
|
237
|
237
|
for the viewer to digest.
|
|
238
|
238
|
- Ensure that we keep it simple and easy to contribute to the project.
|
|
239
|
239
|
|
|
240
|
|
-We are currenlty using the following GitLab features:
|
|
|
240
|
+Explanation of how the project is currenlty using some GitLab features:
|
|
241
|
241
|
|
|
242
|
242
|
- `Milestones`_: we have seen them used in the same way as `Epics`_ in other
|
|
243
|
|
- projects. BuildGrid milestones must be time-line based, can overlap and we can
|
|
244
|
|
- be working towards multiple milestones at any one time. They allow us to group
|
|
245
|
|
- together all sub tasks into an overall aim. See our `BuildGrid milestones`_.
|
|
246
|
|
-- `Labels`_: allow us to filter tickets in useful ways. They do complexity and
|
|
247
|
|
- effort as they grow in number and usage, though, so the general approach is
|
|
248
|
|
- to have the minimum possible. See our `BuildGrid labels`_.
|
|
|
243
|
+ projects and are trying not to do that here. Instead we are going to
|
|
|
244
|
+ use milestones to denote development cycles (ie, two week 'sprints'). See the
|
|
|
245
|
+ `BuildGrid milestones`_.
|
|
|
246
|
+- `Labels`_: allow us to filter tickets (ie, 'issues' in gitlab terminology)
|
|
|
247
|
+ in useful ways. They add complexity and effort as they grow in number, so the
|
|
|
248
|
+ general approach is to have the minimum possible but
|
|
|
249
|
+ ensure we use them consistently. See the `BuildGrid labels`_.
|
|
249
|
250
|
- `Boards`_: allow us to visualise and manage issues and labels in a simple way.
|
|
250
|
|
- For now, we are only utilising one boards. Issues start life in the
|
|
251
|
|
- ``Backlog`` column by default, and we move them into ``ToDo`` when they are
|
|
252
|
|
- coming up in the next few weeks. ``Doing`` is only for when an item is
|
|
253
|
|
- currently being worked on. Moving an issue from column to column automatically
|
|
254
|
|
- adjust the tagged labels. See our `BuildGrid boards`_.
|
|
|
251
|
+ Issues start life in the ``Backlog`` column by default, and we move them into
|
|
|
252
|
+ ``ToDo`` when we aim to complete them in the current development cycle.
|
|
|
253
|
+ ``Doing`` is only for when an item is currently being worked on. When on the
|
|
|
254
|
+ Board view, dragging and dropping an issue from column to column automatically
|
|
|
255
|
+ adjusts the relevant labels. See the `BuildGrid boards`_.
|
|
|
256
|
+
|
|
|
257
|
+
|
|
|
258
|
+Guidelines for using GitLab features when working on this project:
|
|
|
259
|
+
|
|
|
260
|
+- When raising an issue, please:
|
|
|
261
|
+
|
|
|
262
|
+ - check to see if there already is an issue to cover this task (if not then
|
|
|
263
|
+ raise a new one)
|
|
|
264
|
+ - assign the appropriate label or labels (tip: the vast majority of issues
|
|
|
265
|
+ raised will be either an enhancement or a bug)
|
|
|
266
|
+
|
|
|
267
|
+- If you plan to work on an issue, please:
|
|
|
268
|
+
|
|
|
269
|
+ - self-assign the ticket
|
|
|
270
|
+ - ensure it's captured in the current sprint (ie, Gitlab milestone)
|
|
|
271
|
+ - ensure the ticket is in the ``ToDo`` column of the board if you aim to
|
|
|
272
|
+ complete in the current sprint but aren't yet working on it, and
|
|
|
273
|
+ the ``Doing`` column if you are working on it currently.
|
|
|
274
|
+
|
|
|
275
|
+- Please note that Gitlab issues are for either 'tasks' or 'bugs' - ie not for
|
|
|
276
|
+ long discussions (where the mailing list is a better choice) or for ranting,
|
|
|
277
|
+ for example.
|
|
|
278
|
+
|
|
|
279
|
+The above may seem like a lot to take in, but please don't worry about getting
|
|
|
280
|
+it right the first few times. The worst that can happen is that you'll get a
|
|
|
281
|
+friendly message from a current contributor who explains the process. We welcome
|
|
|
282
|
+and value all contributions to the project!
|
|
255
|
283
|
|
|
256
|
284
|
.. _Milestones: https://docs.gitlab.com/ee/user/project/milestones
|
|
257
|
285
|
.. _Epics: https://docs.gitlab.com/ee/user/group/epics
|
