Au commencement, il n'y avait rien... et ce n'est pas rien de le dire !
Quand vous démarrez sur GitHub, ou même si ça fait déjà un moment que vous êtes dessus, si vous n'avez jamais créé de "README de profil", il y a de fortes chances que votre profil ressemble à ceci :
Si ça fait déjà un moment que vous avez des projets hébergés sur la plateforme ou que vous contribuez à des projets Open Source, la section Popular repositories sera plus fournie et la partie "Contribution" ressemblera à une partie de Tetris.
Aujourd'hui, je vous propose de remplacer ce grand vide par quelque chose de plus personnalisé. Vous êtes prêts ? Suivez le guide !
Le README de profil
Le README de profil (README.md) est la première chose que les visiteurs voient lorsqu'ils consultent votre profil GitHub.
Le README de profil est une opportunité unique de faire du personal branding : présenter qui vous êtes, ce que vous faites et ce que vous cherchez à accomplir.
Mais du coup, comment en avoir un ?
Eh bien, il suffit de créer un nouveau repository qui aura pour nom votre nom de profil GitHub. Si l'on reprend l'image du profil en début de cet article, il faudra créer un repository qui s'appellera LeTutourErwan.
Création du repository
Pour créer votre nouveau repository, rien de plus simple, il vous suffit d'aller dans l'onglet repositories et de cliquer sur le bouton New.
Vous arriverez ensuite sur un formulaire et il n'y aura plus qu'à renseigner les différents champs en faisant bien attention à la valeur du champ nom.
Pour rappel il faut qu'elle ait la même valeur que votre nom de profil.
Comme vous pouvez le constater, une fois le nom correctement renseigné, une zone d'information apparaît pour vous signifier qu'il s'agira d'un repository ✨spécial✨ qui sera utilisé pour votre profil.
Et comme il s'agit d'un README profil, il est important de l'initialiser avec un fichier README.md et qu'il soit public.
Il ne vous reste plus qu'à valider le formulaire.
Avoir un profil GitHub qui claque
Maintenant que votre nouveau repository est créé avec son fichier README.md, vous devriez avoir quelque chose comme ça :
Et si vous retournez sur votre profil, vous verrez qu'il y a déjà du changement :
L'extension .md
Depuis tout à l'heure je vous parle du fichier README.md, mais c'est quoi cette extension au juste ?
Eh bien, le md correspond au Markdown, un langage de balisage créé en 2004 (un petit jeune comparé à d'autres langages), qui offre une syntaxe facile à lire et écrire.
Voici pour la petite aparté, maintenant entrons dans le vif du sujet.
Introduction Personnelle
Commencez par une introduction qui donne un aperçu de votre identité professionnelle :
- Nom et titre : Indiquez votre nom et votre titre professionnel (ex. : Développeur Full Stack, Ingénieur DevOps).
- Photo ou avatar : Une image de vous ou un avatar
# Bonjour, je suis [Votre Nom] 👋
## Développeur Full Stack | Passionné de Tech et Open Source
Contact et Réseaux Sociaux
Ajoutez des liens vers vos autres profils professionnels et moyens de contact :
## Contactez-Moi
[](https://linkedin.com/in/votreprofil)
[](https://twitter.com/votreprofil)
[](mailto:votremail@example.com)Compétences Techniques
Listez vos compétences techniques sous forme de badges ou de liste pour un impact visuel fort :
- Langages de Programmation
- Frameworks et Bibliothèques
- Outils et Technologies
## Compétences Techniques
Statistiques GitHub
Affichez vos statistiques GitHub pour démontrer votre activité et vos contributions
- Contributions : Un graphique de vos contributions annuelles.
- Langages utilisés : Un diagramme des langages de programmation que vous utilisez le plus.
## Statistiques GitHub
Vous pouvez générer les images de ces statistiques via des actions GitHub, ou suivre les indications du README.md de ce projet :
Vos articles
Si jamais vous aussi vous écrivez des articles, n'hésitez pas à rajouter des liens vers ces derniers dans votre profil.
Voilà pour ce qui était de remplir votre fichier README.md de profil.
Si vous avez fait attention aux morceaux de code que je vous ai fourni, vous remarquerez qu'ils contiennent pour la grande majorité, des liens vers https://img.shields.io/badge.
Mais à quoi servent les badges exactement ?
Les badges
Les badges GitHub sont des éléments visuels qui permettent de communiquer rapidement des informations clés sur vos projets, compétences, et contributions.
Entre ces 2 blocs qui véhiculent exactement les mêmes informations, lequel a tout de suite attiré votre regard ?
Il y a de grandes chances pour que ce soit le premier.
Les badges sont un excellent moyen de rendre votre profil GitHub plus attractif. Ils permettent aux visiteurs de comprendre rapidement les aspects clés de vos projets et de vos compétences.
En intégrant des badges de manière stratégique, vous pouvez créer un profil GitHub qui non seulement claque, mais qui parle de votre professionnalisme et de votre engagement dans le monde du développement.
Pour les plus paresseux d'entre vous, il existe des générateurs de README.md profil, je vous en propose 2 :
Si jamais vous souhaitez agrémenter votre profil de la mascotte GitHub (l'octocat) mais personnalisée à votre image, c'est par ici.
Conclusion
En soignant votre README de profil GitHub, vous vous présentez sous votre meilleur jour et montrez ce que vous avez à offrir à la communauté.
Un README bien structuré et complet peut grandement améliorer votre visibilité et attirer l'attention des bonnes personnes. Investir du temps dans la création de ce document peut se révéler être un atout majeur dans votre carrière de développeur.
Si jamais vous êtes en mal d'inspiration, vous pouvez également consulter mon README.md profil, j'ai essayé de le faire le plus complet possible.
