📃 Soigner son compte GitHub

Pour beaucoup, un compte GitHub est plus important qu’un CV. En plus d’hĂ©berger du code, de gĂ©rer les versions d’un projets, de permettre Ă  plusieurs personnes de travailler ensemble, GitHub permet de montrer aux curieux ce que vous ĂȘtes capables de faire. Un bon commercial sait qu’un produit se vend mieux s’il a un excellent emballage


Quelques astuces pour chaque repo

  • Choisir un nom de repo explicite. Un visiteur doit comprendre de quoi il s’agit.
  • RĂ©diger une description courte du contenu. A peine plus longue que le titre mais pas trop non plus. Le readme.md est lĂ  pour les dĂ©tails.
  • Rajouter des mots clefs (topics) : une fois le repo crĂ©Ă©, retourne sur la page et clique sur [edit].
  • Mettre l’URL vers le site online et fonctionnel : mĂȘme instruction que ci-dessus. Ça permet au visiteur de visualiser le rĂ©sultat du code hĂ©bergĂ© dans le repo.
  • RĂ©diger un readme.md qui soit une prĂ©sentation et un mode d’emploi du contenu : prĂ©sentation du projet, le contenu du repo, dans quel contexte le projet a Ă©tĂ© rĂ©alisĂ©, dans quel but, Ă  quelle occasion, comment un curieux peut installer le projet chez lui, comment l’utiliser,
 Il faut ĂȘtre le plus complet et explicite possible. Exemple TheDavidDias et son repo “Ressources Front-End Beginner”
Le titre est explicite, la description est claire et limpide, les topics sont présents.

Comment mettre Ă  jour la description et l’URL du repo ?

how to update description and url on a github repo

Comment mettre des topics / keywords ?

how to define topics kewords on a github repo

Quand ton compte contient plusieurs repos : pinned repositories

Si tu as une petite collection de repositories, tu peux choisir d’épingler les plus pertinents avec l’option [pinned repositories].

21 repositories au total, 6 pinned repositories

Comment choisir les pinned repositories ?

how to pin repo on github

Laisser un commentaire

Articles similaires

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

Retour en haut