Templates

Agence nationale de la sécurité des systèmes d'information

Ce projet est édité par l'ANSSI. Pour en savoir plus, voir la page dédiée à la stratégie open source de l'ANSSI. Vous pouvez également cliquer sur les badges pour en savoir plus sur leur signification.

A propos

Ce dépôt contient des fichiers modèles pour les dépôts créés dans l'organisation ANSSI-FR. Ces fichiers, disponibles dans le répertoire modeles représentent la politique par défaut pour les projets open source de l'ANSSI et peuvent être adaptés en fonction de la feuille de route souhaitée par le projet.

• LICENSE contient la license par défaut (Apache 2.0)
• CONTRIBUTING contient la politique de contribution par défaut:
  • les contributions extérieures ne sont pas activement recherchées
  • sont uniquement acceptées les contributions concernant la sécurité
• SECURITY contient la politique de sécurité (contacter opensource@ssi.gouv.fr en cas de problème de sécurité sur un projet)

En complément de ces modèles, un chapô a mettre en début du fichier README.md est aussi disponible dans le répertoire modeles. Ce dernier est disponible en français (chapo_README_FR.md) et en anglais (chapo_README_EN.md) et est à adapter pour refléter le contexte du projet.

Configuration du chapô

Le chapô contient trois badges qu'il convient d'adapter au contexte du projet.

Nom du projet

Le premier badge identifie le projet.

![badge_repo](https://img.shields.io/badge/ANSSI--FR-template-white)

Remplacer la partie nom_du_projet de l'url par le nom de votre projet. Si celui-ci comprend des -, doubler ce caractère pour qu'il soit pris en compte.

Par exemple, utiliser template--test pour afficher .

Catégorie du projet

Ce badge fait référence à la stratégie open source de l'ANSSI présentée sur la page Open source du site de l'agence. Les différents types de projets sont aussi présentés sur la page README.md de l'organisation ANSSI-FR. A chacune des trois catégories est associé un badge que vous pouvez copier/coller pour configurer le chapô. Pour faciliter l'intégration, nous reprenons ici les trois badges et la ligne markdown associée :

• projets doctrinaux

[![badge_catégorie_doctrinal](https://img.shields.io/badge/catégorie-doctrinal-%23e9c7e7)](https://github.com/ANSSI-FR#types-de-projets)

• les outils internes

[![badge_catégorie_interne](https://img.shields.io/badge/catégorie-interne-%23d08fce)](https://github.com/ANSSI-FR#types-de-projets)

• les outils externes

[![badge_catégorie_externe](https://img.shields.io/badge/catégorie-externe-%23b556b6)](https://github.com/ANSSI-FR#types-de-projets)

Version anglaise

Pour les projets en anglais, vous pouvez utiliser les badges suivants :

• doctrinal projects

[![category_badge_doctrinal](https://img.shields.io/badge/category-doctrinal-%23e9c7e7)](https://github.com/ANSSI-FR#types-de-projets)

• internal tools

[![category_badge_internal](https://img.shields.io/badge/category-internal-%23d08fce)](https://github.com/ANSSI-FR#types-de-projets)

• external tools

[![category_badge_external](https://img.shields.io/badge/category-external-%23b556b6)](https://github.com/ANSSI-FR#types-de-projets)

Niveau d'ouverture

Le niveau de contribution attendu par le projet open source est indiqué à l'aide de trois badges tirés de la classification élaborée par la DINUM. Les badges disponibles pour adapter le chapô sont repris avec le visuel et la ligne markdown associée :

• 📘 Niveau A - contributif

[![badge_ouverture_A](https://img.shields.io/badge/code.gouv.fr-contributif-blue)](https://documentation.ouvert.numerique.gouv.fr/les-parcours-de-documentation/ouvrir-un-projet-num%C3%A9rique/#niveau-ouverture)

• 📗 Niveau B - ouvert

[![badge_ouverture_B](https://img.shields.io/badge/code.gouv.fr-ouvert-green)](https://documentation.ouvert.numerique.gouv.fr/les-parcours-de-documentation/ouvrir-un-projet-num%C3%A9rique/#niveau-ouverture)

• 📙 Niveau C - publié

[![badge_ouverture_C](https://img.shields.io/badge/code.gouv.fr-publié-orange)](https://documentation.ouvert.numerique.gouv.fr/les-parcours-de-documentation/ouvrir-un-projet-num%C3%A9rique/#niveau-ouverture)

Version anglaise

Pour les projets en anglais, vous pouvez utiliser les badges suivants :

• 📘 Level A - collaborative

[![openess_badge_A](https://img.shields.io/badge/code.gouv.fr-collaborative-blue)](https://documentation.ouvert.numerique.gouv.fr/les-parcours-de-documentation/ouvrir-un-projet-num%C3%A9rique/#niveau-ouverture)

• 📗 Level B - open

[![openess_badge_B](https://img.shields.io/badge/code.gouv.fr-open-green)](https://documentation.ouvert.numerique.gouv.fr/les-parcours-de-documentation/ouvrir-un-projet-num%C3%A9rique/#niveau-ouverture)

• 📙 Niveau C - published

[![openess_badge_C](https://img.shields.io/badge/code.gouv.fr-published-orange)](https://documentation.ouvert.numerique.gouv.fr/les-parcours-de-documentation/ouvrir-un-projet-num%C3%A9rique/#niveau-ouverture)