📃 Comment faire un readme sur GitHub

Le faire, c’est simple. GĂ©nĂ©ralement, vous le gĂ©nĂ©rez automatiquement quand vous crĂ©ez votre repo. MAIS le plus dur, c’est de le rĂ©diger correctement. Et lĂ , on sait tous que c’est une autre paire de manches.

Questions à se poser


Pour rédiger un readme de qualité, il faut se poser plusieurs questions :

  • Qui a fait le projet : si t’es tout seul, c’est toi mais si tu as bossĂ© en groupe sur un projet, la moindre des choses, c’est de mentionner les copains et (parce qu’on est bien Ă©levĂ©) de mettre leur nom/pseudo en lien vers leur github.
  • Qu’est-ce que c’est ? Est-ce une recette de choucroute ? Non, c’est une application destinĂ© Ă  l’utilisation mobile pour trouver l’ñme sƓur pour un public francophone et aimant la rhubarbe. Bah dis-le !
  • Quand as-tu bossĂ© dessus ? C’était hier ou y’a trois ans ? Parce que certes, le repo sur GitHub mentionnera les dates mais c’est quand mĂȘme plus agrĂ©able Ă  lire quand un humain t’explique que le website vitrine des amoureux de la crevette grise a Ă©tĂ© fait durant l’étĂ© 2015 Ă  l’occasion d’un hackathon qui s’est dĂ©roulĂ© Ă  Miribel.
    Également, la mention des modifications apportĂ©es avec le temps peut avoir son importance pour certaines applications. On les notera dans un “changelog” ou encore un “release notes”. Pour l’exemple, on peut aller ici.
  • OĂč t’étais ? Que faisais-tu ? Au cours de ta carriĂšre de dĂ©veloppeur, tu seras probablement amenĂ© Ă  travailler dans plusieurs boĂźtes. Ca n’a pas le mĂȘme sens si tu expliques que tu as travaillĂ© sur un systĂšme de facturation quand t’étais Senior Developer chez GrosseBoĂźtePrestigieuse que si t’étais apprenant chez BeCodeQuiFormeDesNewbies. Explique-nous oĂč tu en Ă©tais dans ton parcours professionnel quand t’as pondu ton projet.
  • A quoi ça ressemble ? Parce que poster son code, c’est bien mais mettre un petit aperçu sous forme d’une capture d’écran (ou mĂȘme juste le logo de ton application), c’est mieux. Et un lien vers une dĂ©mo en ligne c’est encore plus la classe !
  • La progression
 C’est fini ? C’est en cours ? Tu veux apporter des modifs ? Tu veux qu’on t’aide ?
  • Qu’est-ce que ça contient ? Aide-nous Ă  comprendre en une phrase ce qu’on devrait dĂ©couvrir en plusieurs minutes : est-ce que c’est en MVC, en laravel ? C’est fait de A Ă  Z ? Y’a une base de donnĂ©es ? Si oui, est-ce que le MCD (modĂšle conceptuel de donnĂ©es) est compliqué ? Tu peux nous le mettre dans le readme ?
  • Comment qu’on l’installe ? C’est toujours bien d’expliquer aux copains comment on fait pour installer son travail en local. Soit pour qu’ils puissent l’utiliser, soit pour qu’ils puissent t’aider Ă  l’amĂ©liorer !
  • D’oĂč ça vient ? D’un client ou d’un exercice Ă  faire en classe
 PrĂ©cise !

Petits exemples pour illustrer

Parce qu’une image vaut mille mots (surtout quand c’est moi qui explique) :

source : https://github.com/GaryLuypaert/php-chat-db-ajax

Voici le readme entier de Gary, apprenant dans la promo 01 de BeCode Anderlecht : https://github.com/GaryLuypaert/php-chat-db-ajax

source : https://github.com/GabrieleVir/projet-12-MVC

Autre exemple, le readme intégral de Gabriele, apprenant dans la promo 01 de BeCode Central : https://github.com/GabrieleVir/projet-12-MVC

Petit template pour commencer

Si t’as besoin d’un truc à reprendre et à remplir, fais-toi plaisir avec ceci.

Thanks to Alexandre Plennevaux.

Laisser un commentaire

Articles similaires

Commencez à saisir votre recherche ci-dessus et pressez Entrée pour rechercher. ESC pour annuler.

Retour en haut