Of je nu een compleet nieuw softwareproject start of een “Docs as Code” -benadering wilt volgen met je documentatie op GitHub, een van de eerste stappen is het maken van een repository (repo). Hier is hoe het moet.
Waarom een GitHub-opslagplaats maken?
Git is een open-source gedistribueerd revisiecontrolesysteem waarmee meerdere ontwikkelaars (en schrijvers!) Constant en achtereenvolgens wijzigingen in code of documentatie kunnen aanbrengen en volgen op een gecentraliseerde locatie zonder het werk van iemand anders te overschrijven. Dit versiebeheer zorgt ervoor dat als er iets kapot gaat, u gemakkelijk de bron van het probleem kunt opsporen en terug kunt keren naar een werkende versie voordat de problematische code wordt gepusht.
Het is ook goed om bij te houden wie wat heeft bijgedragen en wanneer. Dit is vooral belangrijk wanneer meerdere mensen uit verschillende tijdzones bijdragen aan één project.
VERWANT: Wat is GitHub en waarvoor wordt het gebruikt?
Door een GitHub-opslagplaats te maken, brengt u deze voordelen naar uw project. Bovendien, als u toestaat dat uw opslagplaats open is voor het publiek, kunnen anderen bijdragen – of dat nu gaat om het repareren van kapotte code of zelfs het corrigeren van typefouten. Mogelijk kunt u zelfs eerder dan gepland een werkende bètaversie uitbrengen. Open source is iets moois.
Een GitHub-opslagplaats maken
Om een project op GitHub op te zetten, moet je een opslagplaats maken. Om dit te doen, logt u in op (of maakt u aan) uw GitHub-account. Nadat u bent ingelogd, klikt u op het pictogram “+” aan de rechterkant van het koptekstmenu (dat overal op de site toegankelijk is). Selecteer “New Repository” in het drop-down menu dat verschijnt.
U bevindt zich nu op de pagina “Een nieuwe opslagplaats maken”. Kies de eigenaar van de opslagplaats en geef deze een korte, gedenkwaardige naam. Houd er rekening mee dat de naam van de opslagplaats URL-vriendelijk moet zijn. Hoewel er geen strikte conventie is, is de meest populaire manier om alle kleine letters te gebruiken bij het scheiden van woorden met een koppelteken, zoals example-repo-name Als u spaties in de naam gebruikt, wordt in plaats daarvan een koppelteken toegevoegd.
Nadat u uw opslagplaats een naam heeft gegeven, geeft u deze een korte beschrijving en kiest u of u de opslagplaats openbaar of privé wilt maken.
Vervolgens kunt u:
- Voeg een README-bestand toe: Introduceer en leg uit hoe u uw project kunt gebruiken en eraan kunt bijdragen.
- Voeg .gitignore toe: Kies welke bestanden u wilt negeren.
- Kies een licentie: Laat anderen weten wat ze wel en niet kunnen doen met de code van uw project.
Deze zijn optioneel, maar worden ten zeerste aanbevolen om toe te voegen. Als u klaar bent, klikt u op ‘Opslagplaats maken’.
Uw opslagplaats is nu aangemaakt.
Nadat u een opslagplaats heeft gemaakt, kunt u deze naar uw lokale computer klonen, zodat u de inhoud lokaal kunt bewerken in plaats van rechtstreeks naar de bronbestanden in de opslagplaats.
VERWANT: Hoe een GitHub-opslagplaats te klonen