Hogyan készíthetek elő és tölthetek fel egy meglévő projektet a GitHubra?
Ebben a leckében a projekt GitHubra való feltöltésének fontos szempontjait tárgyaljuk.
Miért érdemes feltölteni a GitHubra?
A GitHub erényeit több szakirodalom is bővíti, és a modul hatókörén kívül esik, hogy meggyőzze Önt a csatlakozásról. Ebben a modulban azonban összefoglalunk néhány fontos előnyt a feltöltés tervezésekor figyelembe veendő témák kontextusában.
Verziókövetés
A GitHub kizárólag a Gitet használja, amely vitathatatlanul a legjobb verziókövetési rendszer. A Git azonban hihetetlenül kifinomult, és összetett forgatókönyveket hozhat létre olyan kódokkal való munkához, amelyekkel a csapata esetleg nem rendelkezik tapasztalatokkal. Az ágak és a lekéréses kérelmek a Gitet használó fejlesztők mindennapi életének alapvető részét képezik, ezért a GitHubon való sikeres használatukhoz ismerni kell, hogy mikor és hogyan lehet hatékonyan használni őket. Érdemes, hogy a csapat először is megismerkedjen a GitHub-folyamattal, hogy elinduljon a terep.
A kód tárolása a felhőben
A projektkódok nagy része továbbra is kizárólag fejlesztői gépeken van tárolva. Amikor feltölti a GitHubra, a kódot a GitHub felhőplatformjára helyezi át, ahol a csapattagok bárhonnan könnyen elérhetik. Ez az áttérés jó lehetőséget nyújt arra, hogy áttekintse a csapat szabályzatát a verziókövetésben tárolt fájlok és adatok tekintetében. Ajánlott eljárásként azt kell feltételeznie, hogy a GitHubon véglegesített adatok potenciálisan veszélybe kerülnek. Ezért ügyeljen arra, hogy ne tartalmazzon bizalmas adatokat, például API-kulcsokat, jelszavakat vagy más hasonló információkat tartalmazó fájlokat.
Feljegyzés
A GitHub nyilvános és privát adattárakat és részletes hozzáférés-vezérlést is kínál az adattár különböző részeihez. Ez a részletesség lehetővé teszi annak szabályozását, hogy mely projektek láthatók, és hogy az adott felhasználó milyen műveleteket hajthat végre.
Együttműködés
A GitHub kiváló támogatást nyújt a csoportalapú együttműködéshez olyan funkciókkal, mint a problémák, a lekéréses kérelmek és a kódfelülvizsgálatok. A GitHub-folyamat azonban eltérhet azoktól a gyakorlatoktól, amelyekhez a csapata jelenleg hozzászokott. Érdemes megfontolni, hogy csapata hogyan alkalmazkodhat a GitHubhoz, és hogy meg kell-e tartania a meglévő folyamatokat.
Ha a projekt egy nyílt forráskódú projekt, amely lehetővé teszi a külső közreműködők számára, nincs jobb lehetőség, mint a GitHub ezeknek az előnyöknek a maximalizálása.
Feltöltés a GitHubra
A tervezés szempontjai
A GitHubra való feltöltés végrehajtása előtt megfontolandó legfontosabb szempont, hogy meg kell-e őrizni bármit a forrás aktuális állapotán kívül. Használhat például egy számolótáblát vagy egy projektkezelő szoftvert a kijavítani kívánt hibák nyomon követésére. Az elemek áttelepítésének támogatása platformonként változik, és általánosan elérhető a közösségi projektekben. Ez a modul nem terjed ki az ilyen típusú adatok migrálására.
A projektben jelenleg tárolt bináris fájlok kezelése
Ajánlott eljárásként a GitHub-adattárakat a projektek buildeléséhez szükséges fájlokra kell korlátozni. Kerülje a nagyméretű bináris fájlok, például munkadarabok véglegesítését. A bináris fájloknak, például a számolótábláknak és a bemutatóknak jobb helye van az olyan portálokon, amelyek megfelelően tudják biztosítani azok szolgáltatását és verziókezelését. Ha nagy bináris fájlok verziószámozására van szüksége, fontolja meg a Git LFS (Large File Storage) Git-bővítmény használatát.
Fontos Git-fájlok, például .gitignore létrehozása
A Git támogatja .gitignore a fájlokat a verziókövetési fájlszabályzatok kikényszerítéséhez. Ezek a fájlok határozzák meg a fájlok és mappák forráskövetésből való kizárásához használt keresési mintákat. Az alábbi példa rekurzív módon kizárja abin vagy bin nevű mappákat és azok tartalmát a forráskövetési nyomkövetésből.
[Bb]in/
További információ a fájlok figyelmen kívül hagyásáról. Tekintse meg továbbá a .gitignore elérhető, különböző platformokhoz kínált kezdő fájlok gyűjteményét is.
Több más fájl is használatban van a GitHub-projektekben, amelyek a különböző szabályzatokat ismertetik a felhasználók és a közreműködők számára. Akkor is hasznos lehet a szabályzatok egyértelmű meghatározása, ha a projekt privát és korlátozottan hozzáférhető. Bár ezekre a fájlokra nincs szükség, a gyakori fájlok közül néhányat itt talál.
| Fájl | Cél |
|---|---|
README.md |
A könyvtár kezdőlapja. Ez a lap jelenik meg, ha a könyvtárát megtekintik a GitHubon. |
LICENSE.md |
Ez a fájl tartalmazza a kódot tartalmazó licencet. |
CONTRIBUTING.md |
A cikk azt ismerteti, hogy a felhasználók milyen módon járulhatnak hozzá a projekthez, például bemutatja a lekéréses kérelmekre vonatkozó elvárásokat. |
SECURITY.md |
A projekt biztonsági szabályzatát ismerteti. Ez a fájl útmutatást nyújt az olyan felhasználóknak, amelyek bizalmas, biztonsággal kapcsolatos kódot vagy visszajelzést szeretnének küldeni, amelyeket a cím kezelése előtt nem szabad nyilvánosan közzétenni. |
További információ a projekt egészséges hozzájáruláshoz való beállításáról.
Projekt feltöltése a GitHubra
Miután előkészítette az adattárat a feltöltésre, hozzon létre egy adattárat a GitHubon. A létrehozás után lépjen a GitHub-adattár Kód lapjára. Ez a nézet többféle módon is lehetővé teszi a projektkód feltöltését.
Javasoljuk, hogy a forrás feltöltéséhez használja a Git-ügyfelet vagy egy Git-barát eszközt. Másik lehetőségként manuálisan is feltöltheti a fájlokat egy új fájlhivatkozás létrehozásával . Hosszú távon valószínűleg azt fogja tapasztalni, hogy a git-ügyfél használata a legjobb módszer a módosítások, ágak és egyebek kezelésére.