Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 3.27 KB

README.fr.md

File metadata and controls

68 lines (45 loc) · 3.27 KB
Raw

See english version

Critères Awesome CodeGouvFr

Ce dépôt contient une sélection de logiciels libres répondant aux critères suivants :

  1. leur code source est publié sous une licence libre, et documenté ;
  2. ils sont activement maintenus depuis au moins 6 mois, par un ou plusieurs mainteneurs joignables ;
  3. ils ont financés par un ou plusieurs organismes publics ;
  4. ils sont utilisés (soit déployés) par plusieurs administrations.

Ces critères leur confère un caractère fortement réutilisable par toute administration.

Ces projets forment un sous-ensemble de tous ceux que l'on trouve sur code.gouv.fr/public et ils sont publiés sur cette page dédiée : code.gouv.fr/fr/awesome.

Ils sont décrits dans les fichiers *.publiccode.yml du répertoire /dist. Le format de ce fichier est détaillé dans la documentation du format.

Ils sont également publiés au format JSON : code.gouv.fr/data/awesome-codegouvfr.json.

Un exemple de description d'un projet se trouve dans le fichier template.publiccode.yml.

Score Awesome CodeGouvFr

En plus des critères requis, un score Awesome CodeGouvFr est proposé si ces critères optionnels sont vrais :

  1. il existe une page d'accueil du projet (indépendamment du dépôt) ;
  2. la dernière version (tag) date de moins de six mois ;
  3. le dernier commit (dans n'importe quelle branche) date de moins de six mois ;
  4. il existe un logo du projet ;
  5. il existe un fichier ou un lien vers la roadmap (ROADMAP.md) ;
  6. il existe un fichier de description des auteurs (AUTHORS.md ou autre) ;
  7. il existe un fichier décrivant la façon de contribuer (CONTRIBUTING.md) ;
  8. il existe un fichier décrivant les changements (CHANGELOG.md) ;
  9. il existe un code de conduite (CODE_OF_CONDUCT.md) ;
  10. il existe un fichier décrivant la gouvernance (GOVERNANCE.md).

Si un projet valide 7/10 de ces critères, ce badge peut être utilisé dans le README du projet:

Awesome CodeGouvFr score

Ce score permet d'attester l'exemplarité du projet.

Comment contribuer ?

Si votre projet est déjà dans la liste

Si vous souhaitez modifier le fichier *.publiccode.yml de votre projet, vous pouvez directement soumettre une Pull Request avec vos modifications.

Vous pouvez utiliser le template.publiccode.yml comme exemple.

Pour un nouveau projet

Si vous pensez que votre projet répond aux critères d'entrée de la liste, n'hésitez pas à nous écrire à [email protected] pour en discuter.

Vous pouvez également soumettre une Pull Request contenant le fichier *.publiccode.yml de votre projet. Pour le créer, vous pouvez copier le template.publiccode.yml, ou en générer un à partir de la petite API d'outillage dédiée, et le modifier/compléter.

Licence

Les données de ce dépôt sont publiées sous licence Ouverte Etalab 2.0.