- Pourquoi un fichier README existe
- Le README est un contenu essentiel qui détermine la première impression d’un projet de code
- C’est à la fois la vitrine du projet et son mode d’emploi
- Il aide à comprendre pourquoi le code existe, quel problème il résout et en quoi il est important
- Il explique l’objectif du projet, la méthode d’installation et la manière de l’utiliser
- Il fournit des informations importantes à toutes les personnes qui participent au projet et augmente la valeur du code
- Un excellent README peut aussi avoir un impact majeur sur le succès du projet
- Le code existe pour résoudre un problème, et le README doit clairement transmettre l’importance de ce problème ainsi que la manière dont il est résolu
- Un projet sans README
- C’est un labyrinthe sans panneau indicateur
- L’intérêt pour le projet diminue, et un projet utile peut ne pas être largement connu
- Les développeurs ont plus de mal à maintenir et à améliorer le projet
- Il faut beaucoup de temps pour comprendre la structure du code existant ou la manière de l’utiliser
- Exigences pour rédiger un README
- Il doit toujours contenir des informations à jour
- Si le projet change, le README doit être mis à jour lui aussi
- Le README doit rester concis tout en fournissant toutes les informations nécessaires
- Si le contenu devient long, créer de nouveaux fichiers selon les objectifs, puis ajouter des hyperliens
- Ce qu’il faut inclure dans un README
- Principales fonctionnalités et objectif du projet
- Méthode d’installation : guide d’installation étape par étape, outils et bibliothèques nécessaires à l’installation, indications de configuration de l’environnement
- Résolution des problèmes : problèmes fréquents et solutions
- Canaux de support : principaux mainteneurs du projet ou responsables de la communication, et moyens de les contacter
- Informations de licence : la licence précise les droits et restrictions liés à l’utilisation, la modification et la distribution du code
- Journal des modifications : historique des principales mises à jour du projet
- Exemples d’utilisation
- Ressources d’apprentissage complémentaires et liens vers la documentation
- Prérequis : pour aider les utilisateurs à configurer facilement l’environnement nécessaire à l’installation et à l’exécution du projet
Aucun commentaire pour le moment.