Règle de nommage d’un projet

Pour la convention de nommage et les bonne pratiques, il faut que le nom du dépôt ait une approche sémantique pour qu’il soit facilement retrouvé et compréhensible par n’importe qui : Descriptif, Lisible, Cohérent, Contextuel, Extensible et Bref.

  • Acronyme en début de nom pour identifier l’équipe (Exemple : PSC pour ProSantéConnect, SMT pour Serveur Multi-Terminologies)
  • Nom de l’application ou explication de l’application de façon ‘signifiante” en évitant les acronymes pour cette partie.

Par exemple :

[produit/nom du projet]-[objet] e.g. FIG-partage-de-données-de-sante
[produit/nom du projet]-[objet]-[framework/langage] e.g. INT-archetype-java

Il faut également ajouter une description au projet pour que n’importe qui comprenne en une ligne quel est le but du projet.

Pour créer un projet Github dans notre organisation ANS, vous pouvez remplir ce formulaire : https://forms.office.com/e/daAuGUvFgF

Exigences lors de la création d’un projet

  • Création d’un readme.md à la racine du projet qui décrit celui-ci.
  • Ajout d’une licence à la racine du projet (MIT, etalab-2.0… https://www.data.gouv.fr/fr/pages/legal/licences/ )
  • Documenter l’installation si besoin : création d’un fichier install.md
  • Pour la gestion des versions, privilégier le Semver : https://semver.org/lang/fr/
  • Si possible, utiliser un workflow Github pour publier des pages automatiquement (exemple : Design System)
  • Activer Dependabot (ou équivalent) pour vérifier les vulnérabilités des dépendances du projet
  • Faire attention aux informations sensibles (mots de passe, ip…)

Standards de qualité logicielle

  • Le code source est ouvert, y compris à la contribution externe.
  • Le code est instrumenté par des tests automatisés.
  • Le code est déployé fréquemment, idéalement en continu.
  • Le code est écrit en utilisant les standards du langage et des frameworks.

Quelle langue utiliser dans le développement de mon produit ?

Tout ce qui concerne le métier (README, Pull Requests, documentation, …) doit être écrit en français.