Il y a un adage qui dit :

"Un dépôt Github sans README c'est comme un couple sans amour..."

Bon d'accord, il n'y a aucun adage qui ne dit ça, mais comme je tombe sur un nombre incalculable de répos sans description, sans instruction, sans screenshot ni démo, j'ai décidé de vous mettre à disposition un template compatible avec la plupart de vos projets, même ceux en cours de développement (lien disponible à la fin de l'article).

Pourquoi faut-il un fichier readme ?

On pense parfois qu'un projet en cours de développement n'a pas besoin de readme, parce qu'après tout, personne ne va vouloir l'utiliser tant qu'il n'est pas un minimum abouti.

Et même si c'est vrai en théorie, la page d'un projet peut être visitée pour de nombreuses raisons parmi lesquelles :

  • Se tenir au courant des avancées du projet
  • Rechercher un projet similaire au sien afin d'économiser des efforts et s'en inspirer
  • Evaluer la propreté du code
  • En savoir plus sur la manière dont un développeur effectue sa gestion de projet

Toutes ces raisons font que votre projet mérite d'avoir une belle page d'accueil, même sans que ce soit un projet abouti, et ce surtout si vous êtes un développeur junior en recherche d'emploi !

Si je veux en apprendre plus sur les compétences d'un développeur, comment puis-je évaluer le code d'un projet si je ne sais même pas ce qu'est censé faire le-dit projet ?

La réponse est simple : C'est impossible.

De plus, un fichier readme est justement l'endroit parfait pour expliquer qu'un projet est en cours de développement et que le code n'est peut-être pas encore parfaitement propre, qu'il contient encore des logs résiduelles et des méthodes de débuggage qui seront supprimés plus tard !

Le template

Quoi de mieux pour héberger un readme pour vos projet Github que... Github bien évidemment ! Le template contient tous les commentaires nécessaires pour faciliter la réutilisation, alors plus d'excuses pour ne plus en ajouter à vos projets, même les plus simples !

Lien vers le projet Github : https://github.com/NicolasBrondin/basic-readme-template

NicolasBrondin/basic-readme-template
Readme template for simple open-source projects. Contribute to NicolasBrondin/basic-readme-template development by creating an account on GitHub.

En bonus : Si vous ne l'avez pas encore lu, je vous conseille d'aller voir mon article publié précédemment sur mon blog intitulé "Comment héberger gratuitement une démo sur GitHub".

Les articles les plus populaires du blog

Envie de continuer à lire des articles autour du développement web (entre autres) ? Voici la sélection des articles de mon blog les plus lus par la communauté !

Voir la sélection 🚀

Recevez les articles de la semaine par e-mail pour ne rien manquer !

S'abonner à la newsletter 📧

À propos de l'auteur

Hello, je suis Nicolas Brondin-Bernard, ingénieur web indépendant depuis 2015 passionné par le partage d'expériences et de connaissances.

Aujourd'hui je suis aussi coach pour développeurs web juniors, tu peux me contacter sur nicolas@brondin.com, sur mon site ou devenir membre de ma newsletter pour ne jamais louper le meilleur article de la semaine et être tenu au courant de mes projets !


Photo par Jo Szczepanska sur Unsplash