Jak mohu připravit a nahrát existující projekt na GitHub?
V této lekci probereme důležité aspekty nahrání projektu na GitHub.
Proč nahrávat na GitHub?
Existuje množství literatury, která vystihuje výhody GitHubu, a je nad rámec tohoto modulu, abyste vás přesvědčili, abyste se připojili. V tomto modulu však rekapitulace některých klíčových výhod v kontextu témat, které je potřeba zvážit při plánování nahrávání.
Správa verzí
GitHub používá výhradně Git, pravděpodobně nejlepší systém správy verzí. Git je ale neuvěřitelně sofistikovaný a může vytvořit některé složité scénáře pro práci s kódem, se kterým váš tým nemusí mít zkušenosti. Větve a pull requesty jsou základní součástí každodenního života pro vývojáře, kteří používají Git, takže pochopení, kdy a jak je efektivně používat, je nezbytné, aby byli na GitHubu úspěšní. Je vhodné, aby váš tým nejprve porozuměl tok GitHubu, abyste mohli ihned efektivně začít.
Uchování kódu v cloudu
Velké množství kódu projektu je stále uloženo výhradně na vývojářských počítačích. Když nahrajete na GitHub, přesouváte kód na cloudovou platformu GitHubu, kde k němu členové týmu můžou snadno přistupovat odkudkoli. Tato změna nabízí dobrou příležitost k revizi týmových zásad týkajících se toho, jaké druhy souborů a dat uchováváte ve správě verzí. Osvědčeným postupem je předpokládat, že cokoli, co potvrdíte do GitHubu, je potenciálně ohroženo. Proto nezapomeňte zahrnout citlivá data, jako jsou klíče rozhraní API, hesla nebo jiné soubory obsahující srovnatelné informace.
Poznámka:
GitHub nabízí veřejná i privátní úložiště a podrobné řízení přístupu pro různé části úložiště. Tato členitost umožňuje řídit, komu jsou vaše projekty viditelné a jaké akce může daný uživatel provádět.
Spolupráce
GitHub nabízí vynikající podporu pro týmovou spolupráci prostřednictvím funkcí, jako jsou problémy, žádosti o přijetí změn a revize kódu. Tok GitHubu se ale může lišit od postupů, na které je váš tým aktuálně zvyklý. Je vhodné zvážit, jak se váš tým může přizpůsobit GitHubu a jestli byste měli zachovat existující procesy.
Pokud je projekt opensourcový projekt, který umožňuje externím přispěvatelům, neexistuje lepší možnost než GitHub pro maximalizaci těchto výhod.
Nahrání na GitHub
Důležité informace o plánu
Tím nejdůležitějším, co musíte před nahráním na GitHub zvážit, je to, jestli potřebujete zachovat cokoli mimo aktuální stav zdrojového kódu. K sledování chyb, které plánujete opravit, můžete například použít tabulku nebo software pro řízení projektů. Podpora migrace těchto položek se liší podle platformy a je obecně dostupná z komunitních projektů. Tento modul nepokrývá migraci tohoto typu dat.
Zpracování binárních souborů aktuálně uložených v projektu
Úložiště GitHubu by měla být omezena na soubory potřebné k vytváření projektů. Vyhněte se potvrzování velkých binárních souborů, například artefaktů buildu. Binární soubory, jako jsou tabulky a prezentace, se lépe sledují na portálech, které zajišťují jejich obsluhu a správu verzí. Pokud potřebujete verze velkých binárních souborů, zvažte použití rozšíření Git LFS (Large File Storage).
Vytváření důležitých souborů Git, jako je .gitignore
Git podporuje .gitignore soubory, které pomáhají vynucovat zásady souborů správy verzí. Tyto soubory definují vzory hledání používané k vyloučení souborů a složek ze sledování správy zdrojového kódu. Následující příklad rekurzivně vylučuje všechny složky s názvem Bin nebo bin a jejich obsah ze sledování správy zdrojového kódu.
[Bb]in/
Přečtěte si další informace o ignorování souborů. Prohlédněte si také kolekci počátečních .gitignore souborů nabízených pro různé platformy v úložišti Gitignore.
V projektech GitHubu se běžně používá několik dalších souborů, které uživatelům a přispěvatelům úložišť vysvětlují různé zásady. I když je váš projekt privátní a omezený na úzké publikum, přesto může být užitečné tyto zásady výslovně vyjádřit. I když žádný z těchto souborů není povinný, uvádí se zde několik běžných souborů.
| Soubor | Účel |
|---|---|
README.md |
Cílová stránka pro adresář. Tato stránka se zobrazí při prohlížení jejího adresáře na GitHubu. |
LICENSE.md |
Tento soubor obsahuje licenci, pod kterou je kód poskytnut. |
CONTRIBUTING.md |
Vysvětluje, jak by uživatelé měli přispívat k projektu, například očekávání ohledně žádostí o přijetí změn. |
SECURITY.md |
Vysvětluje zásady zabezpečení projektu. Tento soubor obsahuje pokyny pro uživatele, kteří chtějí odeslat citlivý kód související se zabezpečením nebo zpětnou vazbu, která by neměla být veřejně zpřístupněna před vyřešením. |
Přečtěte si další informace o nastavení projektu pro zdravé a efektivní příspěvky.
Nahrání projektu na GitHub
Jakmile je úložiště připravené k nahrání, vytvořte úložiště na GitHubu. Po vytvoření přejděte na kartu Kód úložiště GitHub. Toto zobrazení nabízí několik způsobů, jak nahrávat kód projektu.
K nahrání zdroje doporučujeme použít klienta Git nebo nástroj, který je vhodný pro Git. Alternativně můžete soubory nahrát ručně pomocí vytvoření nového odkazu na soubor . Po dlouhou dobu pravděpodobně zjistíte, že použití klienta Git je nejlepším způsobem, jak spravovat změny, větve a další.