Dépôt du code source

Gestion des versions

Il est recommandé d’avoir une politique de gestion des versions de votre code source. Le guide la gestion sémantique de version propose un guide sur l’attribution et l’incrémentation des numéros de version.

Fichiers présents dans le dépôt

Assurez-vous d’avoir les fichiers suivants à la racine de votre dépôt:

• README : description générale du projet (objectifs, fonctionnement, liens utiles, etc.).
• LICENSE : texte de la licence du logiciel (le répertoire LICENSES peut aussi être utilisé).

Les fichiers suivants présentent également un intérêt:

• CHANGELOG : journal des modifications et correctifs.
• ROADMAP : calendrier de lancement des versions futures.
• CONTRIBUTING : guide de contribution (comment s’impliquer et identification des processus de contribution).
• GOVERNANCE : gouvernance du projet (rôles et droits de votes).
• MAINTAINERS : liste des mainteneurs du projet (ayant des droits de vote ou de commit).
• CODE_OF_CONDUCT : code de conduite des contributeurs.

Ces fichiers doivent être en format texte ou de préférence en format Markdown (on ajoute alors l’extension .md au nom du fichier). Il n’est pas recommandé d’utiliser des formats binaires (PDF ou autres).

Assurez-vous également que les fichiers du dépôt ne contiennent pas d’informations confidentielles (adresses de serveurs, mots de passe, etc.) ou de données nominatives.

Entête des fichiers sources

Chaque fichier de code source devrait indiquer son auteur et son identifiant de licence SPDX. Voici un exemple d’entête de fichier:

 /*
  * Copyright (c) 2018 Gouvernement du Québec
  *
  * SPDX-License-Identifier: LiLiQ-Rplus-1.1
  * License-Filename: LICENSES/LiLiQ-P11unicode.txt
  */