GitHub a publié une fonctionnalité qui permet aux utilisateurs de créer un fichier README au niveau du profil à afficher en évidence sur leur profil GitHub. Cet article explique comment accéder à cette nouvelle fonctionnalité.  Voici par exemple le mien:

créer un profil GitHub style README

Pourquoi READMEs?

La fonction README au niveau du profil GitHub autorise plus de contenu que la bio du profil, prend en charge le markdown, ce qui signifie que vous pouvez plus jouer avec le contenu. Et le README est nettement plus visible car sur la page de profil, il est placé au-dessus des repositories épinglés.

Un README solide est un composant de base d’une application bien documentée et encourage souvent la collaboration en partageant un contexte utile avec les contributeurs. À mon avis, un profil style README semble être une excellente extension d’une convention que beaucoup d’utilisateurs de GitHub connaissent déjà.

Comment créer un profil README?

Le profil README est créé en créant un nouveau dépôt qui porte le même nom que votre nom d’utilisateur. Par exemple, mon nom d’utilisateur GitHub est daviidy, j’ai donc créé un nouveau référentiel avec le nom daviidy.

Remarque: au moment de la rédaction de cet article, pour accéder à la fonction README du profil, la casse des lettres doit correspondre à votre nom d’utilisateur GitHub.

Si vous avez déjà un projet nommé dans un style nom d’utilisateur/nom d’utilisateur et que vous souhaitez configurer un README au niveau du profil, je vous recommande de renommer ce référentiel ou de réutiliser le README du projet existant en fonction de ce qui a le plus de sens dans votre situation particulière.

  1. Créez un nouveau dépôt avec le même nom (y compris la casse) que votre nom d’utilisateur GitHub: https://github.com/new
  2. Créez un fichier README.md dans le nouveau dépôt avec du contenu (texte, GIF, images, emojis, etc.)
  3. Faites un git commit de votre nouveau fichier README!
    • Si vous êtes sur l’interface Web de GitHub, vous pouvez choisir de faire le commit directement dans la branche principale du dépôt (c’est-à-dire masterou main), ce qui le rendra immédiatement visible sur votre profil)
  4. Faites un push sur GitHub (si vous avez effectué des modifications localement, c’est-à-dire sur votre ordinateur et non sur github.com)

Vous êtes libre de recevoir mon cours gratuit sur les fondations du coding et le problem solving

* indicates required