-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.yml
302 lines (282 loc) · 10.8 KB
/
config.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# Default locale for UI strings
locale: "en"
# Customize UI strings
ui-strings:
# display-help: "Display help"
# copy-to-clipboard: "Copy in the clipboard"
# mail-to-message: "Send by email"
# mail-subject: "Results"
# mail-body: "Hi,\n%s\nThanks."
# redo: "Redo"
# ok: "Okay"
# contact-intro: "Contact: "
# toggle-summary-style: "Toggle summary style"
# attention: "Attention"
# Website header
header:
title: "Standard for a Public Code self-assessment"
logo: ""
color: "is-primary"
subtitle: "Check if your codebase is ready for a full assessment."
# Website footer
footer:
text: "Content for this site is generated by [publiccodenet/assessment-eligibility](https://github.com/publiccodenet/assessment-eligibility) which builds upon [Choices](https://git.sr.ht/~bzg/choices)."
contact: "[email protected]"
# Allow users to send you emails with the summary?
mail-to: "[email protected]"
# Display help along with questions by default?
display-help: true
# Display summary when done?
display-summary: true
# Display score information?
display-score: true
# Display each score?
display-score-details: true
# Only the score with the highest value?
display-score-top-result: true
# In a branch of the tree, should the target node be set depending on
# the updated value of conditional-score-outputs?
conditional-navigation: false
# Some text message to always display after the score results
display-unconditionnally: ""
# Set initial variables to register scores. Each entry of
# score-variables start with the name of the variable (you can pick
# up any yaml-acceptable name), then:
#
# (1) "display": what to display when detailed scores are displayed
# (2) "value": the initial value of the variable
# (3) "as-top-result-display": what to display when the variable is
# the one with the highest score when the user is done.
score-variables:
score-standard:
display: "Alignment with the Standard for Public Code"
value: 0
as-percent: true
as-top-result-display: ""
# Set conditional output depending on scores.
# Each entry is composed of the name of the condition (you can pick up
# any yaml-acceptable name), then:
#
# (1) notification (optional): bulma-based class names for the UI notification
# (2) message (mandatory): message to display when one of the condition is met
# (3) anything else is a "condition", which lists variables and their minimal
# values for the condition to be met.
conditional-score-outputs:
cas-1: # free-form
notification: "is-success"
priority: 1
# Final score message supports using formatting strings for
# scores. Strings starting with "%" and matching a score name
# will be interpolated: e.g. here the message will display the
# value of "score-standard".
message: "Perfect score! :) You are absolutely ready to start a full assessment. Contact the Foundation for Public Code at <a href='mailto:[email protected]'>[email protected]</a>."
condition-1: #free-form
# cas-1 is the case when score-standards >= 10
score-standard: 10
cas-2: # free-form
notification: "is-success"
priority: 2
message: "Close enough to start assessment! You have a few things to work on, but we can start an assessment. Contact the Foundation for Public Code at <a href='mailto:[email protected]'>[email protected]</a>."
# When max is set as below, %score-2 above will be formatted as a
# percentage: if score 2 is 10 and max is 10, the percent is 100.
condition-2: #free-form
# cas-2 is the case when score-standard >= 8
score-standard: 8
cas-3: # free-form
notification: "is-warning"
priority: 3
message: "Almost there! You have a few things to work on, but you should soon be ready to start an assessment. Contact the Foundation for Public Code at <a href='mailto:[email protected]'>[email protected]</a> if you have questions."
# When max is set as below, %score-2 above will be formatted as a
# percentage: if score 2 is 10 and max is 10, the percent is 100.
condition-3: #free-form
# cas-2 is the case when score-standard >= 6
score-standard: 6
cas-4: # free-form
notification: "is-danger"
priority: 4
message: "It looks like there is some work to do before you are ready for an assessment. Contact the Foundation for Public Code at <a href='mailto:[email protected]'>[email protected]</a> if you have questions."
# When max is set as below, %score-2 above will be formatted as a
# percentage: if score 2 is 10 and max is 10, the percent is 100.
condition-4: #free-form
# cas-2 is the case when score-standard >= 0
score-standard: 0
# Mandatory configuration option
tree:
- node: "0"
text: "Standard for Public Code"
home-page: true
force-help: true
no-summary: true
help: "The <a href='https://standard.publiccode.net/'>Standard for Public Code</a> is a set of criteria that supports public organizations in developing and maintaining software and policy together.
Anyone developing software or policy for a public purpose can use this standard to work towards higher quality public services that are more cost effective, with less risk and more control.
This self-assessment will let you know how ready your codebase are for a full assessment."
choices:
- answer: "Start now"
goto: "1"
color: "is-info"
- node: "1"
progress: "[1 10]" # progress bar
text: "Is the codebase developed in the open?"
help: "Does the public have insight to the development."
start-page: true
choices:
- answer: "Yes"
summary: "Yes, the codebase is developed in the open."
explain: "Anyone can access the source code and see the backlog, roadmap, etc."
score:
score-standard:
value: 1
goto: "2"
color: "is-info"
- answer: "No"
summary: "No, the codebase is not developed in the open."
color: "is-warning"
explain: "Some parts of the process is kept private."
goto: "3"
- node: "2"
progress: "[2 10]" # progress bar
text: "Does this codebase implement a public policy?"
help: "With policy, we mean laws, regulations, decisions made by a public body or similar."
choices:
- answer: "Yes"
summary: "Yes, the codebase implements a public policy."
score:
score-standard:
value: 1
goto: "3"
color: "is-info"
- answer: "No"
summary: "No, the codebase does not implement a public policy."
color: "is-warning"
goto: "3"
- node: "3"
progress: "[3 10]" # progress bar
text: "Is the codebase used in multiple contexts, or are you pursuing it to be?"
help: ""
choices:
- answer: "Yes"
summary: "Yes, the codebase is meant to be used for multiple contexts."
score:
score-standard:
value: 1
goto: "4"
color: "is-info"
- answer: "No"
summary: "No, the codebase is not used in multiple contexts now and we are not actively pursuing it."
color: "is-warning"
goto: "4"
- node: "4"
progress: "[4 10]" # progress bar
text: "Are contributions from more than one organization encouraged?"
help: "Is this publishing code for transparency or to enable collaboration?"
choices:
- answer: "Yes"
summary: "Yes, we welcome contributions."
score:
score-standard:
value: 1
goto: "5"
color: "is-info"
- answer: "No"
summary: "No, other organizations are not encouraged to contribute to the codebase."
color: "is-warning"
goto: "5"
- node: "5"
progress: "[5 10]" # progress bar
text: "Is it easy for someone outside your organization to initiate a contribution?"
help: "If someone outside your organization wanted to contribute, could they?"
choices:
- answer: "Yes"
summary: "Yes, anyone can contribute."
score:
score-standard:
value: 1
goto: "6"
color: "is-info"
- answer: "No"
summary: "No, it is not easy for anyone to contribute."
color: "is-warning"
goto: "6"
- node: "6"
progress: "[6 10]" # progress bar
text: "Is the source code in a publicly accessible version control system (such as GitLab or GitHub)?"
help: ""
choices:
- answer: "Yes"
summary: "Yes, the surce code is in a publicly accessible version control system."
score:
score-standard:
value: 1
goto: "7"
color: "is-info"
- answer: "No"
summary: "No, the source code is not in a publicly accessible version control system."
color: "is-warning"
goto: "7"
- node: "7"
progress: "[7 10]" # progress bar
text: "Is review of contributions required?"
help: ""
choices:
- answer: "Yes"
summary: "Yes, review of contributions is required."
score:
score-standard:
value: 1
goto: "8"
color: "is-info"
- answer: "No"
summary: "No, review of contributions is not required."
color: "is-warning"
goto: "8"
- node: "8"
progress: "[8 10]" # progress bar
text: "Are codebase and community objectives documented?"
help: ""
choices:
- answer: "Yes"
summary: "Yes, codebase and community objectives are documented."
score:
score-standard:
value: 1
goto: "9"
color: "is-info"
- answer: "No"
summary: "No, codebase and community objectives are not documented."
color: "is-warning"
goto: "9"
- node: "9"
progress: "[9 10]" # progress bar
text: "Are you striving to use English as the primary language in the codebase?"
help: ""
choices:
- answer: "Yes"
summary: "Yes, we strive to use English as the primary language."
score:
score-standard:
value: 1
goto: "10"
color: "is-info"
- answer: "No"
summary: "No we do not strive to use English as the primary language."
color: "is-warning"
goto: "10"
- node: "10"
progress: "[10 10]" # progress bar
text: "Does it have an open license?"
help: "Licenses that are [approved by OSI or FSF](https://spdx.org/licenses/) are open enough."
choices:
- answer: "Yes"
summary: "Yes, the codebase has an open license."
score:
score-standard:
value: 1
goto: "end"
color: "is-info"
- answer: "No"
summary: "No, the codebase does not have an open license."
color: "is-warning"
goto: "end"
- node: "end"
text: "Result"
done: true