Ci-dessous une proposition de readme pour tout projet
Dans cette section, on décrit la vision générale du projet ainsi que ses objectifs à destination des futurs utilisateurs et des développeurs.
Pour ce dépôt :
Ce dépôt permet de répertorier les différents éléments essentiels dans un dépôt SIDC :
- ce ReadMe
- des modèles de tickets type pour des ajouts de fonctionnalité, réparation de bug, ajout de documentation, maintenance/montée de version...
- des milestones témoins (ex: backlog, sprint1...)
- des exemples de github Actions CI/CD (lancement de test, build d'images...)
- des exemples de label pour les futurs tickets
La procédure d'installation du projet doit être décrite dans cette section ou dans un fichier complémentaire dont le lien est présent ici.
Lien vers la documentation pour les développeurs, à la fois pour maintenir le projet, le déployer et ajouter de nouvelles fonctionnalités. Schémas UML...
Exemple d'arborescence de projet :
.github/: dossier contenant les modèles d'issues et github actions ;.vscode/: dossier contenant une configuration vscode pour le projet;doc/: dossier contenant des fichiers .md de documentation (ex: install.md) ;tests/: scripts et explications pour lancer les tests ;README.md: ce fichier
Ici on met la liste des personnes qui travaillent sur ce projet et le maintiennent à jour.
| Nom | Prénom | fonction | |
|---|---|---|---|