Hur förbereder och laddar jag upp ett befintligt projekt till GitHub?
I den här lektionen diskuterar vi viktiga överväganden för att ladda upp ett projekt till GitHub.
Varför bör man ladda upp till GitHub?
Det finns mängder av litteratur som prisar Fördelarna med GitHub, och det ligger utanför omfånget för den här modulen för att övertyga dig om att gå med. I den här modulen sammanfattar vi dock några av de viktigaste fördelarna inom ramen för ämnen som du behöver tänka på när du planerar uppladdningen.
Versionskontroll
GitHub använder endast Git, utan tvekan det bästa versionskontrollsystemet. Git är dock otroligt avancerat och kan skapa några komplexa scenarier för att arbeta med kod som ditt team kanske inte har erfarenhet av. Grenar och pull-begäranden är en grundläggande del av det dagliga arbetet för utvecklare som använder Git. Därför behöver du förstå när och hur dessa ska användas för att lyckas på GitHub. Det är värt att ditt team först känner till GitHub-flödet så att du kan komma igång.
Hålla koden i molnet
En stor mängd projektkod lagras fortfarande uteslutande på utvecklardatorer. När du laddar upp till GitHub flyttar du din kod till GitHubs molnplattform, där teammedlemmar enkelt kan komma åt den var som helst. Den här ändringen ger en bra möjlighet att granska teamets princip för de typer av filer och data som du lagrar i versionskontroll. Som bästa praxis bör du anta att allt du checkar in på GitHub kan komma att komprometteras. Se därför till att inte inkludera känsliga data, till exempel API-nycklar, lösenord eller andra filer som innehåller jämförbar information.
Kommentar
GitHub erbjuder både offentliga och privata lagringsplatser och detaljerade åtkomstkontroller för olika delar av en lagringsplats. Med den här kornigheten kan du styra vilka dina projekt är synliga för och vilka åtgärder en viss användare kan utföra.
Samarbete
GitHub erbjuder utmärkt stöd för teamsamarbete med funktioner såsom ärenden, pull-begäranden och kodgranskningar. GitHub-flödet kan dock skilja sig från de metoder som ditt team för närvarande är vant vid. Det är en bra idé att överväga hur ditt team kan anpassa sig till GitHub och om du ska behålla några befintliga processer eller inte.
Om projektet är ett projekt med öppen källkod som tillåter externa deltagare finns det inget bättre alternativ än GitHub för att maximera dessa fördelar.
Ladda upp till GitHub
Planera överväganden
Det viktigaste att tänka på innan du genomför uppladdningen till GitHub är huruvida du behöver behålla allt utöver det aktuella tillståndet för din källkod. Du kan till exempel använda ett kalkylblad eller projekthanteringsprogram för att spåra buggar som du planerar att åtgärda. Stöd för att migrera dessa objekt varierar beroende på plattform och är allmänt tillgängligt från communityprojekt. Den här modulen omfattar inte migrering av den typen av data.
Hantera binära filer som för närvarande lagras i projektet
Som bästa praxis bör GitHub-lagringsplatser vara begränsade till de filer som krävs för att bygga projekt. Undvik att checka in stora binära filer, till exempel bygg-artefakter. Binära filer såsom kalkylblad och presentationer är bättre att spåras i portaler som förstår hur de ska betjänas och versionshanteras korrekt. Om du behöver versionshantera stora binära filer bör du överväga att använda Git-tillägget Git LFS (Large File Storage).
Skapa viktiga Git-filer som .gitignore
Git stöder .gitignore filer för att framtvinga filprinciper för versionskontroll. Dessa filer definierar de sökmönster som används för att undanta filer och mappar från källkontrollspårning. I följande exempel undantas rekursivt alla mappar som kallas Bin eller bin och deras innehåll från källkontrollspårning.
[Bb]in/
Läs mer om att Ignorera filer. Ta även en titt på samlingen av .gitignore-startfiler som erbjuds för olika plattformar på lagringsplatsen för gitignore.
Det finns flera andra filer som ofta används i GitHub-projekt till att förklara olika principer för lagringskonsumenter och -deltagare. Även om ditt projekt är privat och begränsat till en begränsad målgrupp kan det fortfarande vara användbart att uttryckligen förklara dessa principer. Inga av dessa filer krävs, men några av de vanliga filerna visas här.
| Fil | Syfte |
|---|---|
README.md |
Landningssidan för katalogen. Den här sidan renderas när dess katalog visas på GitHub. |
LICENSE.md |
Den här filen innehåller den licens under vilken koden tillhandahålls. |
CONTRIBUTING.md |
Förklarar hur användarna bör bidra till projektet, till exempel förväntningar kring pull-begäranden. |
SECURITY.md |
Förklarar säkerhetsprincipen för projektet. Den här filen ger vägledning till användare som vill skicka känslig säkerhetsrelaterad kod eller feedback som inte bör offentliggöras innan de åtgärdas. |
Läs mer om att Konfigurera ditt projekt för felfria bidrag.
Ladda upp projektet till GitHub
När lagringsplatsen har förberetts för uppladdning skapar du en lagringsplats på GitHub. När den har skapats går du till fliken Kod på GitHub-lagringsplatsen. Den här vyn ger dig flera sätt att ladda upp din projektkod.
Vi rekommenderar att du använder git-klienten eller ett Git-vänligt verktyg för att ladda upp din källa. Alternativt kan du ladda upp filer manuellt med hjälp av länken skapa en ny fil. På lång sikt kommer du förmodligen att upptäcka att det bästa sättet att hantera ändringar, grenar och mycket annat är att använda en git-klient .