-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconfig.yml
417 lines (388 loc) · 14.2 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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
# Default locale for UI strings
# Available UI languages: en, fr, de, sv
locale: "fr"
# Available themes: bulma, chota, dsfr
# You can set the theme on the command line with
# clj -X:set :theme bulma
theme: "dsfr"
# Customize UI strings
ui-strings:
# 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: "Guide Awesome CodeGouvFr"
subtitle: "Le logiciel libre publié par votre administration est-il *remarquable* ? Faites le test."
# Website footer
footer:
text: "Site construit avec [choices](https://git.sr.ht/~codegouvfr/guide-awesome/) et maintenu par la [mission logiciels libres](https://code.gouv.fr) de la DINUM."
contact: "[email protected]"
# Allow users to send you emails with the summary?
mail-to: "[email protected]"
# Display summary when done?
display-summary: true
# Display score information?
display-score: true
# Display each score?
# Mostly useful for debugging
display-score-details: false
# Display the score with the highest value?
# Only when :as-top-result-display is set for each score
display-score-top-result: false
# In a branch of the tree, should the target node be set depending on
# the updated value of conditional-score-output?
conditional-navigation: false
# Some text message to always display after the score results
display-unconditionally: false
# Set initial variables to register scores.
score-variables:
# "score-1" is a user-defined string
score-0:
# What to display when displaying score details:
#display: "Votre score Awesome CodeGouvFr est de "
# Initial value for score-1:
value: 0
# When you when the score message to use percent:
as-percent: false
# Max is needed for displaying percent:
max: 4
# Only needed when display-score-top-result is true
#as-top-result-display: "1 wins :)"
score-1:
# What to display when displaying score details:
#display: "Votre score Awesome CodeGouvFr est de "
# Initial value for score-1:
value: 0
# When you when the score message to use percent:
as-percent: true
# Max is needed for displaying percent:
max: 10
# Only needed when display-score-top-result is true
#as-top-result-display: "1 wins :)"
# Set conditional output depending on scores.
conditional-score-output:
# Cases are tested one by one. The first case that matches is the
# main score. When case have a priority value, the matching case
# with the highest priority is the main score.
cas-1: # free-form condition name
# priority: 2 # Use priority to matching order
color: "is-success" # Bulma-based class names for the UI
# notification. Available values for colors are: is-success,
# is-info, is-warning, is-danger.
message: "Bravo, vous satisfaites %score-1% des critères !"
# In score-variables, when :max is set and :as-percent is true,
# then the score will be shown as a percentage.
condition-1:
score-0: 4
score-1: 8 # This condition is met when score-1 is >= 2
cas-2:
color: "is-warning"
message: "%score-1%, pas mal ! Rendez-vous sur notre [documentation](https://code.gouv.fr/documentation/#/publier) pour progresser."
condition-1:
score-0: 4
score-1: 6 # This condition is met when score-1 is >= 1
cas-3:
color: "is-danger"
message: "À %score-1%, il y a encore un peu de travail. Rendez-vous sur la [doc](https://code.gouv.fr/documentation/#/publier) pour progresser."
condition-1:
score-0: 4
score-1: 0 # This condition is met when score-1 is >= 0
cas-4:
color: "is-danger"
message: "Vous ne remplissez que %score-0 des quatre conditions prérequises."
condition-1:
score-0: 0
score-1: 0
# Mandatory configuration option
tree:
- node: "0"
text: "Un test pour connaître le score **Awesome CodeGouvFr** de votre logiciel."
home-page: true
no-summary: false
help: "La mission logiciels libres promeut les logiciels libres remarquables publiés par des administrations. Des logiciels qui sont sous licence libre, activement maintenus, financés et utilisés. En plus de ces quatre critères requis pour entrer dans la liste, nous leur attribuons un score s'ils respectent 10 autres [critères optionnels](https://github.com/codegouvfr/awesome-codegouvfr?tab=readme-ov-file#awesome-codegouvfr-score). Vous pouvez en savoir plus en lisant [notre entrée de blog](https://code.gouv.fr/fr/blog/awesome-codegouvfr-logiciels-libres-remarquables-de-ladministration/) et notre [documentation](https://code.gouv.fr/documentation/#/publier)."
choices:
- answer: "Commencer"
goto: "a"
color: "is-info"
- node: "a"
text: "Le logiciel est-il publié sous licence libre ?"
help: "Un logiciel libre est un logiciel que chacun peut librement étudier, utiliser, modifier et dont il peut distribuer des versions modifiées. Voir notre [guide juridique sur l'ouverture](https://code.gouv.fr/guides/juridique/) si besoin."
start-page: true
progress: "[0 14]"
choices:
- answer: "Oui"
summary: "Le logiciel est publié sous licence libre."
score:
score-0:
value: 1
goto: "b"
color: "is-success"
- answer: "Non"
summary: "Le logiciel n'est pas publié sous licence libre."
color: "is-danger"
score:
score-0:
value: 0
goto: "not-awesome"
- node: "b"
text: "Le logiciel est-il activement maintenu ?"
help: "Un logiciel est activement maintenu si une équipe corrige ses bugs voire continue de le faire évoluer. Voir notre documentation sur les [degrés d'ouverture](https://code.gouv.fr/documentation/#/publier?id=quels-degr%c3%a9s-d39ouverture-pour-les-codes-sources-) d'un logiciel."
progress: "[1 14]"
choices:
- answer: "Oui"
summary: "Le logiciel est activement maintenu."
score:
score-0:
value: 1
goto: "c"
color: "is-success"
- answer: "Non"
summary: "Le logiciel n'est pas activement maintenu."
color: "is-danger"
score:
score-0:
value: 0
goto: "not-awesome"
- node: "c"
text: "Le logiciel est-il actuellement financé ?"
help: "Les logiciels libres de la liste Awesome CodeGouvFr doivent tous actuellement recevoir des fonds publics d'une ou plusieurs administrations."
progress: "[2 14]"
choices:
- answer: "Oui"
summary: "Le logiciel est actuellement financé."
score:
score-0:
value: 1
goto: "d"
color: "is-success"
- answer: "Non"
summary: "Le logiciel n'est pas actuellement financé."
color: "is-danger"
score:
score-0:
value: 0
goto: "not-awesome"
- node: "d"
text: "Le logiciel est-il utilisé par plusieurs administrations ?"
help: "Dans une logique de mutualisation, plusieurs administrations font confiance à celles des administrations qui portent les logiciels libres de la liste Awesome CodeGouvFr."
progress: "[3 14]"
choices:
- answer: "Oui"
summary: "Le logiciel est utilisé par plusieurs administrations."
score:
score-0:
value: 1
goto: "1"
color: "is-success"
- answer: "Non"
summary: "Le logiciel n'est pas utilisé par au moins une administration."
color: "is-danger"
score:
score-0:
value: 0
goto: "not-awesome"
- node: "not-awesome"
text: "Désolé, votre logiciel ne peut pas entrer dans la liste Awesome CodeGouvFr."
done: true
- node: "1"
progress: "[0 14]"
text: "Y a-t-il une page web présentant le projet, en plus du dépôt de code source ?"
help: "Une page dédiée au projet aide à le faire connaître au-delà de la forge."
progress: "[4 14]"
choices:
- answer: "Oui"
summary: "Il y a une page web pour le projet, en plus du dépôt de code source."
score:
score-1:
value: 1
goto: "2"
color: "is-success"
- answer: "Non"
summary: "Il n’y a pas une page web pour le projet indépendante du dépôt de code source."
color: "is-danger"
score:
score-1:
value: 0
goto: "2"
- node: "2"
progress: "[5 14]"
text: "La dernière version date-t-elle de moins de six mois ?"
help: "Si votre projet est toujours actif, dites-le dans votre `README.md`."
choices:
- answer: "Oui"
summary: "La dernière version date de moins de six mois."
score:
score-1:
value: 1
goto: "3"
color: "is-success"
- answer: "Non"
summary: "La dernière version date de plus de six mois."
score:
score-1:
value: 0
color: "is-danger"
goto: "3"
- node: "3"
progress: "[6 14]"
text: "Le dernier commit (toutes branches confondues) date-t-il de moins de six mois ?"
help: "Si votre projet est toujours actif, dites-le dans votre `README.md`."
choices:
- answer: "Oui"
summary: "Oui, le dernier commit date de moins de six mois."
goto: "4"
color: "is-success"
score:
score-1:
value: 1
- answer: "Non"
summary: "Le dernier commit date d'il y a plus de six mois."
score:
score-1:
value: 0
color: "is-danger"
goto: "4"
- node: "4"
progress: "[7 14]"
text: "Le projet a-t-il un logo ?"
help: "Un logo aide à identifier et faire connaître votre projet."
choices:
- answer: "Oui"
summary: "Le projet a un logo."
color: "is-success"
goto: "5"
score:
score-1:
value: 1
- answer: "Non"
summary: "Le projet n'a pas de logo."
color: "is-danger"
goto: "5"
score:
score-1:
value: 0
- node: "5"
progress: "[8 14]"
text: "Y a-t-il un fichier `ROADMAP.md` dans le dépôt pour décrire la feuille de route ?"
help: "Un fichier `ROADMAP.md` est un bon moyen d'anticiper les attentes et d'encourager les contributions."
choices:
- answer: "Oui"
summary: "Il y a un fichier `ROADMAP.md` dans le dépôt pour décrire la feuille de route."
color: "is-success"
goto: "6"
score:
score-1:
value: 1
- answer: "Non"
summary: "Il n’y a pas de fichier `ROADMAP.md` dans le dépôt."
color: "is-danger"
goto: "6"
score:
score-1:
value: 0
- node: "6"
progress: "[9 14]"
text: "Y a-t-il un fichier `AUTHORS.md` dans le dépôt avec la liste des auteurs ?"
help: "Un fichier `AUTHORS.md` permet de lister les auteurs principaux et leur rôle, passé ou présent."
choices:
- answer: "Oui"
summary: "Il y a un fichier `AUTHORS.md` dans le dépôt."
color: "is-success"
goto: "7"
score:
score-1:
value: 1
- answer: "Non"
summary: "Il n’y a pas de fichier `AUTHORS.md` dans le dépôt."
color: "is-danger"
goto: "7"
score:
score-1:
value: 0
- node: "7"
progress: "[10 14]"
text: "Y a-t-il un fichier `CONTRIBUTING.md` dans le dépôt expliquant comment contribuer ?"
help: "Le fichier `CONTRIBUTING.md` aide les contributeurs à aider utilement."
choices:
- answer: "Oui"
summary: "Il y a un fichier `CONTRIBUTING.md` dans le dépôt."
color: "is-success"
goto: "8"
score:
score-1:
value: 1
- answer: "Non"
summary: "Il n’y a pas de fichier `CONTRIBUTING.md` dans le dépôt."
color: "is-danger"
goto: "8"
score:
score-1:
value: 0
- node: "8"
progress: "[11 14]"
text: "Y a-t-il un fichier `CHANGELOG.md` dans le dépôt avec la liste des changements principaux ?"
help: "Il est utile de proposer un fichier `CHANGELOG.md` en plus de l'historique des commits."
choices:
- answer: "Oui"
summary: "Il y a un fichier `CHANGELOG.md` dans le dépôt."
color: "is-success"
goto: "9"
score:
score-1:
value: 1
- answer: "Non"
summary: "Il n’y a pas de fichier `CHANGELOG.md` dans le dépôt."
color: "is-danger"
goto: "9"
score:
score-1:
value: 0
- node: "9"
progress: "[12 14]"
text: "Y a-t-il un fichier `CODE_OF_CONDUCT.md` dans le dépôt et un code de conduite pour le projet ?"
help: "Le code de conduite est utile pour modérer les échanges en ligne et en présentiel, il indique à vos utilisateurs et contributeurs que vous souhaitez rendre votre projet le plus inclusif possible."
choices:
- answer: "Oui"
summary: "Il y a un fichier `CODE_OF_CONDUCT.md` dans le dépôt."
color: "is-success"
goto: "10"
score:
score-1:
value: 1
- answer: "Non"
summary: "Il n’y a pas de fichier `CODE_OF_CONDUCT.md` dans le dépôt."
color: "is-danger"
goto: "10"
score:
score-1:
value: 0
- node: "10"
progress: "[13 14]"
text: "Y a-t-il un fichier `GOVERNANCE.md` dans le dépôt présentant la gouvernance du projet ?"
help: "Un fichier `GOVERNANCE.md` détaille le « qui fait quoi » et aide vos contributeurs à comprendre les règles d'acceptation des contributions."
choices:
- answer: "Oui"
summary: "Il y a un fichier `GOVERNANCE.md` dans le dépôt."
color: "is-success"
goto: "end"
score:
score-1:
value: 1
- answer: "Non"
summary: "Il n’y a pas de fichier `GOVERNANCE.md` dans le dépôt."
color: "is-danger"
goto: "end"
score:
score-1:
value: 0
- node: "end"
progress: "[14 14]"
text: "C'est terminé ! N'oubliez pas de consulter notre [documentation](https://code.gouv.fr/documentation/#/publier)."
done: true