Cum pregătesc și încarc un proiect existent pe GitHub?
În această unitate, discutăm aspectele importante pentru încărcarea unui proiect în GitHub.
De ce să încărcați pe GitHub?
Există volume de literatură care extolează virtuțile GitHub și este dincolo de domeniul acestui modul pentru a vă convinge să vă alăturați. Cu toate acestea, în acest modul recapitulăm unele dintre avantajele cheie în contextul subiectelor pe care trebuie să le luați în considerare atunci când planificați încărcarea.
Controlul versiunii
GitHub utilizează exclusiv Git, probabil cel mai bun sistem de control al versiunilor din jurul său. Totuși, Git este incredibil de sofisticat și poate crea unele scenarii complexe pentru lucrul cu cod cu care este posibil ca echipa dvs. să nu aibă experiență. Ramurile și solicitările de extragere sunt o parte fundamentală a vieții de zi cu zi pentru dezvoltatorii care utilizează Git, prin urmare, înțelegerea când și cum să le utilizați eficient este necesară pentru a avea succes pe GitHub. Este util ca echipa dvs. să fie familiarizată mai întâi cu fluxul GitHub, astfel încât să puteți ajunge la rularea terenului.
Păstrați codul în cloud
Un volum mare de cod de proiect este stocat în continuare exclusiv pe mașinile pentru dezvoltatori. Atunci când încărcați în GitHub, mutați codul pe platforma cloud GitHub, unde membrii echipei îl pot accesa cu ușurință de oriunde. Această modificare oferă o ocazie bună de a revizui politica echipei dvs. pentru tipurile de fișiere și datele pe care le păstrați în controlul versiunii. Ca exemplu de bună practică, ar trebui să presupuneți că tot ce comiteți la GitHub este posibil compromis. Prin urmare, nu uitați să includeți date sensibile, cum ar fi chei API, parole sau alte fișiere care conțin informații comparabile.
Notă
GitHub oferă atât depozite publice, cât și private, precum și controale de acces granular pentru diferite părți ale unui depozit. Această granularitate vă permite să controlați cine sunt vizibile proiectele dvs. și ce acțiuni poate efectua un anumit utilizator.
Colaborare
GitHub oferă asistență excelentă pentru colaborarea în echipă prin caracteristici precum probleme, solicitări de tragere și recenzii de cod. Cu toate acestea, fluxul GitHub poate diferi de practicile la care este obișnuit în prezent echipa dvs. Este o idee bună să luați în considerare modul în care echipa dvs. se poate adapta la GitHub și dacă ar trebui sau nu să păstrați procese existente.
Dacă proiectul este un proiect open-source care permite colaboratori externi, nu există nicio opțiune mai bună decât GitHub pentru maximizarea acestor beneficii.
Încărcare în GitHub
Considerații de plan
Cel mai important lucru de luat în considerare înainte de a executa încărcarea în GitHub este dacă trebuie să păstrați orice dincolo de starea curentă a sursei. De exemplu, puteți utiliza o foaie de calcul sau un software de management de proiect pentru a urmări erorile pe care intenționați să le remediați. Suportul pentru migrarea acestor elemente variază în funcție de platformă și este disponibil în general de la proiectele de comunitate. Acest modul nu acoperă migrarea acelui tip de date.
Gestionați fișierele binare stocate în prezent în proiect
Ca un exemplu de bună practică, depozitele de GitHub ar trebui să fie limitate la fișierele necesare pentru construirea proiectelor. Evitați comiterea fișierelor binare mari, cum ar fi construirea artefactelor. Fișierele binare, cum ar fi foile de calcul și prezentările, sunt mai potrivite pentru a fi urmărite pe portaluri care înțeleg cum să le servească și să le versiuniz corect. Dacă aveți nevoie să editați fișiere binare mari, luați în considerare utilizarea extensiei Git Git LFS (Spațiu de stocare mare pentru fișiere).
Creați fișiere Git importante, cum ar fi .gitignore
Git acceptă fișiere .gitignore pentru a impune politici de fișier de control al versiunilor. Aceste fișiere definesc modelele de căutare utilizate pentru a exclude fișierele și folderele din urmărirea controlului sursă. Următorul exemplu exclude recursiv orice foldere de denumite Bin sau binși conținutul lor din urmărirea controlului sursă.
[Bb]in/
Aflați mai multe despre Ignorarea fișierelor. De asemenea, consultați colecția de fișiere starter .gitignore oferite pentru diverse platforme în depozitul gitignore.
Există mai multe alte fișiere utilizate frecvent în proiectele GitHub pentru a explica politici diferite consumatorilor și colaboratorilor depozitului. Chiar dacă proiectul dvs. este privat și restricționat la un public limitat, poate fi util să rostiți în mod explicit aceste politici. Deși niciunul dintre aceste fișiere nu este necesar, câteva dintre cele comune sunt listate aici.
| Fișier | Scop |
|---|---|
README.md |
Pagina de destinație pentru director. Această pagină este redată atunci când directorul său este vizualizat pe GitHub. |
LICENSE.md |
Acest fișier conține licența sub care este furnizat codul. |
CONTRIBUTING.md |
Explică modul în care utilizatorii ar trebui să contribuie la proiect, cum ar fi obținerea așteptărilor. |
SECURITY.md |
Explică politica de securitate pentru proiect. Acest fișier oferă instrucțiuni utilizatorilor care doresc să trimită cod de securitate sensibil sau feedback care nu ar trebui dezvăluit public înainte de a fi adresat. |
Aflați mai multe despre Configurarea proiectului pentru contribuții sănătoase.
Încărcați-vă proiectul în GitHub
După ce depozitul este pregătit pentru încărcare, creați un depozit pe GitHub. După creare, navigați la fila Cod din depozitul GitHub. Această vizualizare vă oferă mai multe modalități de a încărca codul proiectului.
Vă recomandăm să utilizați clientul git sau un instrument prietenos cu Git pentru a încărca sursa. Alternativ, puteți încărca manual fișierele utilizând crearea unui fișier nou link. Pe termen lung, este posibil să descoperiți că utilizarea unui client git este cea mai bună modalitate de a gestiona modificările, ramurile și multe altele.