Hvordan forbereder og uploader jeg et eksisterende projekt til GitHub?
I dette undermodul gennemgår vi de vigtige overvejelser i forbindelse med upload af et projekt til GitHub.
Hvorfor uploade til GitHub?
Der er mængder litteratur, der fortæller om GitHubs dyder, og det ligger uden for dette moduls anvendelsesområde for at overbevise dig om, at du skal deltage. Men i dette modul opsummerer vi nogle af de vigtigste fordele inden for rammerne af emner, du skal overveje, når du planlægger din upload.
Versionsstyring
GitHub bruger udelukkende Git, som nok er det bedste versionskontrolsystem. Git er dog utroligt sofistikeret og kan oprette nogle komplekse scenarier til at arbejde med kode, som dit team muligvis ikke oplever. Branches og pullanmodninger er en grundlæggende del af det daglige liv for udviklere, der bruger Git, så det er nødvendigt at forstå, hvornår og hvordan de skal bruges effektivt, for at få succes på GitHub. Det er værd for dit team først at blive fortrolig med GitHub-flowet, så du kan komme i gang.
Hold din kode i cloudmiljøet
En stor mængde projektkode gemmes stadig udelukkende på udviklercomputere. Når du uploader til GitHub, flytter du din kode til GitHubs cloudplatform, hvor teammedlemmer nemt kan få adgang til den overalt. Denne ændring giver dig en god mulighed for at gennemse dit teams politik for de typer filer og data, du bevarer i versionsstyringen. Som bedste praksis bør du antage, at alt, hvad du forpligter dig til GitHub, potentielt er kompromitteret. Sørg derfor for ikke at inkludere følsomme data, f.eks. API-nøgler, adgangskoder eller andre filer, der indeholder sammenlignelige oplysninger.
Seddel
GitHub tilbyder både offentlige og private lagre og kontrolelementer til detaljeret adgang til forskellige dele af et lager. Med denne granularitet kan du styre, hvem dine projekter er synlige for, og hvilke handlinger en given bruger kan udføre.
Samarbejde
GitHub tilbyder fremragende support til teamsamarbejde via funktioner som problemer, pullanmodninger og kodeanmeldelser. GitHub-flowet kan dog afvige fra de fremgangsmåder, som dit team i øjeblikket er vant til. Det er en god idé at overveje, hvordan dit team kan tilpasse sig GitHub, og om du skal bevare eksisterende processer eller ej.
Hvis dit projekt er et projekt med åben kildekode, der tillader eksterne bidragydere, er der ingen bedre mulighed end GitHub for at maksimere disse fordele.
Upload til GitHub
Overvejelser i forbindelse med planen
Det vigtigste, du skal overveje, før du udfører din upload til GitHub, er, om du skal bevare noget ud over din kildes aktuelle tilstand. Du kan f.eks. bruge et regneark eller et projektstyringsprogram til at spore fejl, du planlægger at løse. Understøttelsen af migrering af disse elementer varierer afhængigt af platformen og er generelt tilgængelig fra communityprojekter. Dette modul dækker ikke overførsel af denne type data.
Håndter binære filer, der i øjeblikket er gemt i projektet
Som bedste praksis bør GitHub-lagre begrænses til de filer, der er nødvendige for at bygge projekter. Undgå at oprette store binære filer, f.eks. buildartefakter. Binære filer som regneark og præsentationer er bedre egnet til at blive sporet på portaler, der forstår, hvordan de skal betjenes og versioneres korrekt. Hvis du har brug for at versionere store binære filer, kan du overveje at bruge Git-filtypenavnet Git LFS (Large File Storage).
Opret vigtige Git-filer som .gitignore
Git understøtter .gitignore filer for at gennemtvinge filpolitikker for versionsstyring. Disse filer definerer de søgemønstre, der bruges til at udelade filer og mapper fra sporing af kildekontrol. I følgende eksempel udelades alle mapper, der kaldes Bin eller bin, og deres indhold, fra sporing af kildekontrol.
[Bb]in/
Få mere at vide om Ignorere filer. Tjek også samlingen af starter .gitignore filer, der tilbydes til forskellige platforme i gitignore-lageret.
Der er flere andre filer, der ofte bruges i GitHub-projekter til at forklare forskellige politikker for lagerforbrugere og bidragydere. Selvom dit projekt er privat og begrænset til en begrænset målgruppe, kan det stadig være nyttigt at formulere disse politikker eksplicit. Selvom ingen af disse filer er påkrævet, vises nogle af de almindelige filer her.
| Fil | Formål |
|---|---|
README.md |
Landingssiden for mappen. Denne side gengives, når dens mappe vises på GitHub. |
LICENSE.md |
Denne fil indeholder den licens, som koden er angivet under. |
CONTRIBUTING.md |
Forklarer, hvordan brugerne skal bidrage til projektet, f.eks. forventninger til pullanmodninger. |
SECURITY.md |
Forklarer projektets sikkerhedspolitik. Denne fil indeholder en vejledning til brugere, der ønsker at indsende følsom sikkerhedsrelateret kode eller feedback, som ikke bør offentliggøres, før de behandles. |
Få mere at vide om Konfiguration af dit projekt til sunde bidrag.
Upload dit projekt til GitHub
Når dit lager er klar til upload, skal du oprette et lager på GitHub. Når du har oprettet den, skal du gå til fanen Code i dit GitHub-lager. Denne visning giver dig flere måder at få din projektkode uploadet på.
Vi anbefaler, at du bruger git--klienten eller et Git-brugervenligt værktøj til at uploade din kilde. Du kan også uploade dine filer manuelt ved hjælp af oprette en ny fil link. I det lange løb vil du sandsynligvis opdage, at brug af en git--klient er den bedste måde at administrere ændringer, forgreninger og meget mere på.