Hvordan klargjør og laster jeg opp et eksisterende prosjekt til GitHub?

  • 8 minutter

I denne enheten diskuterer vi viktige hensyn for å laste opp et prosjekt til GitHub.

Hvorfor laste opp til GitHub?

Det er volumer av litteratur som fremhever gitHubs dyder, og det er utenfor omfanget av denne modulen for å overbevise deg om å bli med. I denne modulen oppsummerer vi imidlertid noen av de viktigste fordelene i sammenheng med emner du må vurdere når du planlegger opplastingen.

Versjonskontroll

GitHub bruker utelukkende Git, uten tvil det beste versjonskontrollsystemet rundt. Git er imidlertid utrolig sofistikert og kan opprette noen komplekse scenarioer for å arbeide med kode som teamet kanskje ikke har erfaring med. Branches og pull-forespørsler er en grunnleggende del av det daglige livet for utviklere som bruker Git, så det er nødvendig å forstå når og hvordan de skal bruke dem effektivt for å lykkes på GitHub. Det er verdt at teamet først blir kjent med GitHub-flyten, slik at du kan komme i gang.

Behold koden i skyen

En stor mengde prosjektkode lagres fortsatt utelukkende på utviklermaskiner. Når du laster opp til GitHub, flytter du koden til GitHubs skyplattform, der gruppemedlemmer enkelt kan få tilgang til den fra hvor som helst. Denne endringen gir en god mulighet til å se gjennom teamets policy for hvilke typer filer og data du har i versjonskontroll. Som en anbefalt fremgangsmåte bør du anta at alt du forplikter deg til GitHub, potensielt er kompromittert. Så pass på at du ikke inkluderer sensitive data, for eksempel API-nøkler, passord eller andre filer som inneholder sammenlignbar informasjon.

Notat

GitHub tilbyr både offentlige og private repositorier og detaljerte tilgangskontroller for ulike deler av et repositorium. Med denne detaljnivået kan du kontrollere hvem prosjektene dine er synlige for, og hvilke handlinger en gitt bruker kan utføre.

Samarbeid

GitHub tilbyr utmerket støtte for teamsamarbeid gjennom funksjoner som problemer, pull-forespørsler og kodevurderinger. GitHub-flyten kan imidlertid avvike fra praksisene teamet er vant til for øyeblikket. Det er lurt å vurdere hvordan teamet kan tilpasse seg GitHub, og om du bør beholde eksisterende prosesser eller ikke.

Hvis prosjektet er et åpen kildekode-prosjekt som tillater eksterne bidragsytere, finnes det ikke noe bedre alternativ enn GitHub for å maksimere disse fordelene.

Last opp til GitHub

Planlegg vurderinger

Det viktigste du bør vurdere før du kjører opplastingen til GitHub, er om du må beholde noe utover den gjeldende tilstanden til kilden. Du kan for eksempel bruke et regneark eller en prosjektstyringsprogramvare til å spore feil du planlegger å løse. Støtte for overføring av disse elementene varierer etter plattform, og er generelt tilgjengelig fra fellesskapsprosjekter. Denne modulen dekker ikke overføring av denne typen data.

Håndtere binære filer som for øyeblikket er lagret i prosjektet

Som anbefalt fremgangsmåte bør GitHub-repositorier begrenses til filene som er nødvendige for å bygge prosjekter. Unngå å utføre store binære filer, for eksempel byggartefakter. Binære filer som regneark og presentasjoner er bedre egnet til å spores på portaler som forstår hvordan du kan betjene og versjon dem riktig. Hvis du har behov for å bruke store binærfiler, bør du vurdere å bruke Git-filtypen Git LFS (Stor fillagring).

Opprette viktige Git-filer som GITIGNORE

Git støtter .gitignore filer for å håndheve filpolicyer for versjonskontroll. Disse filene definerer søkemønstrene som brukes til å utelate filer og mapper fra kildekontrollsporing. Følgende eksempel utelater rekursivt eventuelle mapper kalt Bin eller bin, og innholdet, fra kildekontrollsporing.

[Bb]in/

Lær mer om hvordan du ignorerer filer. Se også samlingen av starter-.gitignore filer som tilbys for ulike plattformer i gitignore repositorium.

Det finnes flere andre filer som vanligvis brukes i GitHub-prosjekter for å forklare ulike policyer for repositoriumforbrukere og bidragsytere. Selv om prosjektet er privat og begrenset til et begrenset publikum, kan det fortsatt være nyttig å eksplisitt artikulere disse policyene. Selv om ingen av disse filene kreves, er noen av de vanlige oppført her.

Fil Hensikt
README.md Målsiden for katalogen. Denne siden gjengis når katalogen vises på GitHub.
LICENSE.md Denne filen inneholder lisensen som koden er angitt under.
CONTRIBUTING.md Forklarer hvordan brukere skal bidra til prosjektet, for eksempel forventninger til pull-forespørsler.
SECURITY.md Forklarer sikkerhetspolicyen for prosjektet. Denne filen gir veiledning til brukere som ønsker å sende inn sensitiv sikkerhetsrelatert kode eller tilbakemelding som ikke bør offentliggjøres før de blir adressert.

Lær mer om Konfigurere prosjektet for sunne bidrag.

Last opp prosjektet til GitHub

Når repositoriet er klargjort for opplasting, oppretter du et repositorium på GitHub. Når du er opprettet, går du til Code-fanen i GitHub-repositoriet. Denne visningen gir deg flere måter å laste opp prosjektkoden på.

Skjermbilde av import av kode til et GitHub-repositorium.

Vi anbefaler at du bruker git--klienten eller et Git-vennlig verktøy til å laste opp kilden. Du kan også laste opp filene manuelt ved hjelp av opprette en ny fil kobling. I det lange løp vil du sannsynligvis oppdage at bruk av en git--klient er den beste måten å administrere endringer, grener og mer på.