Hoe kan ik een bestaand project voorbereiden en uploaden naar GitHub?
In deze les bespreken we de belangrijke overwegingen voor het uploaden van een project naar GitHub.
Waarom uploaden naar GitHub?
Er zijn veel literatuur die de deugden van GitHub verheerst en het valt buiten het bereik van deze module om u ervan te overtuigen deel te nemen. In deze module maken we echter een overzicht van enkele belangrijke voordelen binnen de context van onderwerpen die u moet overwegen bij het plannen van uw upload.
Versiebeheer
GitHub maakt uitsluitend gebruik van Git, misschien wel het beste versiebeheersysteem. Git is echter ongelooflijk geavanceerd en kan complexe scenario's maken voor het werken met code waarmee uw team mogelijk niet wordt ervaren. Vertakkingen en pull-aanvragen vormen een fundamenteel onderdeel van het dagelijkse leven voor ontwikkelaars die Git gebruiken, dus inzicht in wanneer en hoe ze effectief kunnen worden gebruikt, is nodig om succesvol te zijn op GitHub. Het is de moeite waard voor uw team om eerst vertrouwd te zijn met de GitHub flow, zodat u snel aan de slag kunt.
Bewaar uw code in de cloud
Een grote hoeveelheid projectcode wordt nog steeds exclusief op ontwikkelcomputers opgeslagen. Wanneer u uploadt naar GitHub, verplaatst u uw code naar het cloudplatform van GitHub, waar teamleden deze vanaf elke locatie eenvoudig kunnen openen. Deze wijziging biedt een uitgelezen kans om het beleid van uw team te controleren op de typen bestanden en gegevens die u in versiebeheer opneemt. Als best practice moet u ervan uitgaan dat alles wat u doorvoert op GitHub mogelijk is aangetast. Zorg er dus voor dat u geen gevoelige gegevens opneemt, zoals API-sleutels, wachtwoorden of andere bestanden die vergelijkbare informatie bevatten.
Notitie
GitHub biedt zowel openbare als privéopslagplaatsen en gedetailleerde toegangsbeheer voor verschillende onderdelen van een opslagplaats. Met deze granulariteit kunt u bepalen voor wie uw projecten zichtbaar zijn en welke acties een bepaalde gebruiker kan uitvoeren.
Samenwerking
GitHub biedt uitstekende ondersteuning voor teamsamenwerking via functies zoals problemen, pull-aanvragen en codebeoordelingen. De GitHub-stroom kan echter verschillen van de procedures waarmee uw team momenteel gewend is. Het is een goed idee om na te gaan hoe uw team zich kan aanpassen aan GitHub en of u bestaande processen moet behouden.
Als uw project een opensource-project is dat externe inzenders toestaat, is er geen betere optie dan GitHub om deze voordelen te maximaliseren.
Uploaden naar GitHub
Overwegingen voor plannen
Het belangrijkste om rekening mee te houden voordat u uploadt naar GitHub, is of u de huidige status van uw bron moet behouden. U kunt bijvoorbeeld een spreadsheet of software voor projectbeheer gebruiken om fouten bij te houden die u wilt oplossen. Ondersteuning voor het migreren van deze items verschilt per platform en is algemeen beschikbaar vanuit communityprojecten. Deze module heeft geen betrekking op het migreren van dat type gegevens.
Binaire bestanden verwerken die momenteel zijn opgeslagen in uw project
Als best practice moeten GitHub-opslagplaatsen worden beperkt tot de bestanden die nodig zijn voor het bouwen van projecten. Vermijd het doorvoeren van grote binaire bestanden, zoals buildartefacten. Binaire bestanden, zoals spreadsheets en presentaties, zijn beter geschikt om te volgen op portals die weten hoe ze op de juiste wijze moeten worden gebruikt en van versie-informatie moeten worden voorzien. Als u een versie van grote binaire bestanden nodig hebt, kunt u overwegen om de Git-extensie Git LFS (Large File Storage) te gebruiken.
Belangrijke Git-bestanden maken, zoals .gitignore
Git ondersteunt .gitignore bestanden om bestandsbeleid voor versiebeheer af te dwingen. Deze bestanden definiëren de zoekpatronen die worden gebruikt om bestanden en mappen uit te sluiten van tracering van broncodebeheer. In het volgende voorbeeld worden mappen met de naam Bin of Bin en de bijbehorende inhoud recursief uitgesloten van tracering van broncodebeheer.
[Bb]in/
Meer informatie over het negeren van bestanden. Bekijk ook de verzameling startersbestanden .gitignore die worden aangeboden voor verschillende platforms in de gitignore-opslagplaats.
Er zijn verschillende andere bestanden die vaak worden gebruikt in GitHub-projecten om verschillende beleidsregels uit te leggen aan gebruikers en inzenders. Zelfs als uw project privé is en voorbehouden aan een beperkt publiek, kan het nog steeds handig zijn om deze beleidsregels expliciet te verwoorden. Hoewel geen van deze bestanden vereist is, worden hier enkele van de algemene bestanden vermeld.
| Bestand | Doel |
|---|---|
README.md |
De landingspagina voor de map. Deze pagina wordt weergegeven wanneer de map ervan wordt weergegeven op GitHub. |
LICENSE.md |
Dit bestand bevat de licentie waaronder de code is opgegeven. |
CONTRIBUTING.md |
Hierin wordt uitgelegd hoe gebruikers bijdragen aan het project, zoals de verwachtingen met betrekking tot pull-aanvragen. |
SECURITY.md |
Hierin wordt het beveiligingsbeleid voor het project uitgelegd. Dit bestand bevat richtlijnen voor gebruikers die gevoelige beveiligingsgerelateerde code of feedback willen verzenden die niet openbaar mag worden gemaakt voordat ze worden geadresseerd. |
Meer informatie over het instellen van uw project voor gezonde bijdragen.
Uw project uploaden naar GitHub
Zodra uw opslagplaats is voorbereid voor uploaden, maakt u een opslagplaats op GitHub. Nadat u het bestand hebt gemaakt, gaat u naar het tabblad Code van uw GitHub-opslagplaats. Deze weergave biedt u verschillende manieren om uw projectcode te uploaden.
U wordt aangeraden de Git-client of een Git-vriendelijk hulpprogramma te gebruiken om uw bron te uploaden. U kunt uw bestanden ook handmatig uploaden met behulp van de koppeling voor het maken van een nieuw bestand . In de loop van de lange termijn zult u waarschijnlijk merken dat het gebruik van een Git-client de beste manier is om wijzigingen, vertakkingen en meer te beheren.