ABCDEFGHIJKLMNOPQRSTUVWXYZ
1
2
StepInstructions
3
1Identify the Git workflow W to characterise and access the appropriate section in the shared document containing the workflow descriptions: Workflow Descriptions
4
2When reading the workflow's description, start by identifying the different types of repositories that are considered (you can check the repositories catalogue to identify the different types)
5
3Next, determine the different types of categories of guidelines stipulated for the current workflow (from: repository set up and initialisation, file management, syncing, branching strategy, code integration strategy or additional features). You can check what each of these categories means in the framework categories catalogue
6
4And, finally, highlight in the description the statements that indicate a guideline to be followed by any contributors following workflow W (for example: "... the developer must branch off develop to start working on a new feature...), assigning to each of these guidelines a level of enforcement according to the following table
7
5Open the spreadsheet with the features to identify based on the description of the Git workflow. You can go through the informative tabs (Dictionary, Terminology, Catalogues, Constraints) to familiarise yourself with the features to be used to characterise W
8
6Go to the framework tab and position yourself in the column of the workflow to be characterised (e.g., for GitFlow)
9
7Start the characterisation by selecting the categories (1 to 6) identified in step 3, under the Enforce/Select column of the workflow to be characterised, for the feature 0.a (Framework setup - Category selection). This will enable (or disable) the corresponding categories in the cells below, allowing you to focus on those aspects of the workflow that are stated in the description
10
8For the next feature 0.b (Framework setup - Assign role), identify which roles from the Role column (E) correspond to which of the development line(s) under the column Options (F), depending on those that can be extracted from W’s description, and tick the corresponding row under the column Enforce/Select using the dropdown list under the workflow that is being characterised. The definitions of roles and development lines are available on the tab Feature dictionary and the description of each of the available options are included in tab Catalogues. The roles identified in this feature will be used in the rest of the features/sub-feature whenever a role or roles need to be selected.
11
9For each feature Fd (from those guidelines identified in the workflow's description in step 4) in the following rows, fill the columns Enforce/Select and Attributes (if applicable) under the workflow W to characterise, depending on the type of feature (and assigning the enforcement level identified in step 4), and follow the instructions in steps 9.a - 9.d, accordingly. The attribute column can be used to specify remote repositories R<rr> (from those identified in step 2) or parameters that might be required by the feature (e.g., number of weeks for preparing a new release). Some features may have dependencies with other features wether because they need other features to be defined first, or because other features might need to be checked once the current one has a value assigned. These dependencies can be found in the tab Constraints
12
9.a[Simple feature/sub-feature] If Fd has several options to pick from (without parameters enclosed in <>), select the one that corresponds more closely to what is being described in W’s description for Fd, based on the definitions provided in the Feature dictionary and Terminology tabs, and following the examples in the tab Content examples. For example, number of weeks = 3
In the row corresponding to the selected option, and in the column corresponding to Enforce/Select under the workflow W to characterise, select one of the alternatives from the dropdown list, that corresponds to the level of enforcement of Fd for W. These enforcement levels are described in the following table
13
9.b[Feature/sub-feature with associated attributes] If Fd has several options to pick from (and parameters enclosed in <>), select the one that corresponds more closely to what is being described in W’s description for Fd, based on the definitions provided in the Feature dictionary and Terminology tabs, and following the examples in the tab Content examples, and identify the value(s) for the parameter(s) in <>.
In the row corresponding to the selected option, and in the column Enforce/Select under the workflow W to characterise, select one of the alternatives from the dropdown list, that corresponds to the level of enforcement of Fd for W. These enforcement levels are described in a table
Under the attribute column, fill the value(s) identified for the corresponding parameter(s) as a single value or as a list depending on the number of attributes to associate with this feature. For example R<rr> corresponds to the other repository being referred from the current one and the value of the actual repository must be added to the Attribute column accordingly (e.g., R<rr> = R2).
14
9.c[Feature/sub-feature with associated roles] If Fd includes a list of roles in the Role column (E), identify to which role(s), the feature/sub-feature to characterise applies, and select the corresponding option from the Options column (F) for the relevant roles, taking into account that a role may correspond to one or more of the development lines identified in the “Assign role” feature (step 8).
15
9.d[Feature/sub-feature with associated event] If Fd is a feature/sub-feature that indicates a creation or deletion event for the branching strategy, or an integration event for the code integration strategy, you can use the relevant catalogues from the tab Catalogues to understand the meaning of each of these events.
16
10If this is the last feature/sub-feature Fd go to step 11, otherwise go to step 9.
17
11Characterisation completed.
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100