Comment (et pourquoi) créer un référentiel GitHub
Que vous commenciez un tout nouveau projet logiciel ou que vous souhaitiez adopter une approche «Docs as Code» avec votre documentation sur GitHub, l’une des premières étapes consiste à créer un référentiel (repo). Voici comment procéder.
Pourquoi créer un dépôt GitHub?
Git est un système de contrôle de révision distribué open source qui permet à plusieurs développeurs (et écrivains!) D’apporter et de suivre constamment et consécutivement les modifications du code ou de la documentation dans un emplacement centralisé sans remplacer le travail de quelqu’un d’autre. Ce contrôle de version fait en sorte que si quelque chose se brise, vous pouvez facilement rechercher la source du problème et revenir à une version de travail avant que le code problématique ne soit poussé.
C’est également bon pour savoir qui a contribué à quoi et quand. Ceci est particulièrement important lorsque plusieurs personnes de différents fuseaux horaires contribuent à un projet.
En créant un référentiel GitHub, vous apportez ces avantages à votre projet. De plus, si vous autorisez votre dépôt à être ouvert au public, d’autres peuvent contribuer, qu’il s’agisse de corriger du code cassé ou même de corriger les fautes de frappe. Vous pourrez peut-être même publier une version bêta fonctionnelle avant la date prévue. L’open source est une belle chose.
Comment créer un dépôt GitHub
Pour configurer un projet sur GitHub, vous devez créer un dépôt. Pour ce faire, connectez-vous à (ou créez) votre compte GitHub. Une fois connecté, cliquez sur l’icône «+» sur le côté droit du menu d’en-tête (qui est accessible de n’importe où sur le site). Sélectionnez «Nouveau référentiel» dans le menu déroulant qui apparaît.
Vous serez maintenant sur la page «Créer un nouveau référentiel». Choisissez le propriétaire du repo et donnez-lui un nom court et mémorable. Gardez à l’esprit que le nom du dépôt doit être compatible avec les URL. Bien qu’il n’y ait pas de convention stricte, la méthode la plus courante consiste à utiliser toutes les lettres minuscules tout en séparant les mots par un trait d’union, comme example-repo-name. Si vous utilisez des espaces dans le nom, un tiret sera ajouté à sa place.
Une fois que vous avez nommé votre dépôt, donnez-lui une brève description et choisissez si vous souhaitez rendre le dépôt public ou privé.
Ensuite, vous pouvez:
Celles-ci sont facultatives mais fortement recommandées à ajouter. Lorsque vous êtes prêt, cliquez sur « Créer un référentiel ».
Votre dépôt est maintenant créé.
Une fois que vous avez créé un référentiel, vous pouvez le cloner sur votre machine locale, ce qui vous permet d’apporter des modifications au contenu localement plutôt que directement dans les fichiers source du référentiel.
