Miten voin valmistella ja ladata olemassa olevan projektin GitHubiin?
Tässä osiossa keskustellaan tärkeistä huomioitavista asioista, kun projekti ladataan GitHubiin.
Miksi lataat GitHubiin?
GitHubin hyveitä ylistää kirjallisuutta paljon, ja tämän moduulin ulkopuolelle voit vakuuttaa sinut liittymään. Tässä moduulissa kiteytämme kuitenkin joitain tärkeimpiä etuja niiden aiheiden kontekstissa, joita sinun on otettava huomioon palvelimeen lataamista suunniteltaessa.
Versionhallinta
GitHub käyttää yksinomaan Git, joka on kiistatta paras versionhallintajärjestelmä. Git on kuitenkin uskomattoman hienostunut ja voi luoda monimutkaisia skenaarioita koodityöskenaarioiden luomiseen, joita tiimisi ei ehkä ole kokenut. Haarat ja pull-pyynnöt ovat olennainen osa Gitiä käyttävien kehittäjien jokapäiväistä elämää, joten niiden tehokkaan käytön ymmärtäminen ja käyttäminen on tarpeen GitHubissa menestymiseksi. Kannattaa, että tiimisi tutustuu ensin GitHub-työnkulkuun jotta pääset alkuun.
Koodin säilyttäminen pilvipalvelussa
Suuri osa projektikoodista tallennetaan edelleen vain kehittäjäkoneisiin. Kun lataat GitHubiin, siirrät koodisi GitHubin pilviympäristöön, jossa tiimin jäsenet voivat käyttää sitä helposti mistä tahansa. Tämä muutos tarjoaa hyvän mahdollisuuden tarkistaa tiimisi käytäntöä sille, millaisia tiedostoja ja tietoja säilytät versionhallinnassa. Parhaana käytäntönä on olettaa, että kaikki GitHubiin sitoutuvat tiedot saattavat vaarantua. Älä siis sisällytä luottamuksellisia tietoja, kuten ohjelmointirajapinta-avaimia, salasanoja tai muita tiedostoja, jotka sisältävät vertailukelpoisia tietoja.
Muistiinpano
GitHub tarjoaa sekä julkisia että yksityisiä säilöjä sekä eriytettyjä käyttöoikeuksien valvontatoimintoja säilön eri osien osalta. Tämän askelvälin avulla voit hallita, kenelle projektisi näkyvät ja mitä toimintoja tietty käyttäjä voi suorittaa.
Yhteistyö
GitHub tarjoaa erinomaisen tuen tiimiyhteistyölle eri ominaisuuksien, kuten ongelmien, pull-pyyntöjen ja kooditarkistusten kautta. GitHub-työnkulku saattaa kuitenkin poiketa käytännöistä, joihin tiimisi on tällä hetkellä tottunut. Kannattaa harkita, miten tiimisi sopeutuu GitHubiin ja pitääkö aiemmin luodut prosessit säilyttää.
Jos projektisi on avoimen lähdekoodin projekti, joka sallii ulkopuoliset osallistujat, ei ole olemassa parempaa vaihtoehtoa kuin GitHub näiden etujen maksimointiin.
Lataa GitHubiin
Huomioitavaa suunnitelmasta
Tärkeintä on ottaa huomioon ennen latauksen suorittamista GitHubiin, onko sinun säilytettävä mitään muuta kuin lähteesi nykyinen tila. Saatat esimerkiksi käyttää laskentataulukkoa tai projektinhallintaohjelmistoa korjataksesi virheitä. Näiden kohteiden siirtämisen tuki vaihtelee ympäristön mukaan, ja se on yleisesti saatavilla yhteisöprojekteista. Tässä moduulissa ei käsitellä kyseisen tyyppisten tietojen siirtämistä.
Projektiin tallennettujen binaaritiedostojen käsitteleminen
Parhaana käytäntönä GitHub-säilöt tulee rajata projekteissa tarvittaviin tiedostoihin. Vältä suurten binaaritiedostojen, kuten koontiarteaktien, vahvistamista. Binaaritiedostot, kuten laskentataulukot ja esitykset, sopivat paremmin seurantaan portaaleissa, jotka osaavat tarjota ja versioida ne oikein. Jos haluat versioida suuret binaaritiedostot, harkitse Git-laajennuksen Git LFS (Large File Storage).
Luo tärkeitä Git-tiedostoja, kuten .gitignore
Git tukee .gitignore tiedostoja, joiden avulla voit pakottaa versionhallintatiedostojen käytännöt. Nämä tiedostot määrittävät hakutavat, joita käytetään suljettaessa tiedostoja ja kansioita lähteen hallinnan seurannasta. Seuraavassa esimerkissä rekursiivisesti pois kansiot, joita kutsutaan Bin tai lokeron, ja niiden sisällön lähteen hallinnan seurannasta.
[Bb]in/
Lue lisätietoja tiedostojen ohittamisesta. Tutustu myös Gitignore-säilön eri alustoille tarjottavien .gitignore-tiedostojen kokoelmaan.
GitHub-projekteissa käytetään usein useita muita tiedostoja, joiden avulla eri käytännöt selitetään säilön kuluttajille ja osallistujille. Vaikka projektisi olisi yksityinen ja rajattu rajoitetulle kohderyhmälle, nämä käytännöt kannattaa silti nimenomaisesti ottaa huomioon. Vaikka mitään näistä tiedostoista ei tarvita, joitakin yleisiä on lueteltu täällä.
| Tiedosto | Tarkoitus |
|---|---|
README.md |
Hakemiston aloitussivu. Tämä sivu hahmonnetaan, kun sen hakemistoa tarkastellaan GitHubissa. |
LICENSE.md |
Tämä tiedosto sisältää käyttöoikeuden, jonka nojalla koodi annetaan. |
CONTRIBUTING.md |
Tässä kerrotaan, miten käyttäjien tulisi osallistua projektiin, kuten pull-pyynnön odotukset. |
SECURITY.md |
Tässä artikkelissa selitetään projektin suojauskäytäntö. Tämä tiedosto sisältää ohjeita käyttäjille, jotka haluavat lähettää arkaluontoista suojaukseen liittyvää koodia tai palautetta, jota ei tule julkistaa ennen sen käsittelemistä. |
Lue lisätietoja Projektin määrittäminen terveille panoksille.
Lataa projektisi GitHubiin
Kun säilö on valmis ladattavaksi, luo säilö GitHubiin. Kun koodi on luotu, siirry GitHub-säilön Code -välilehteen. Tämä näkymä tarjoaa useita tapoja ladata projektikoodisi.
Suosittelemme, että lataat lähteesi palvelimeen Git -asiakkaan tai Git-ystävällisen työkalun avulla. Vaihtoehtoisesti voit ladata tiedostot manuaalisesti käyttämällä uuden tiedoston luomisen linkkiä. Pitkällä aikavälillä huomaat todennäköisesti, että Git -asiakkaan käyttäminen on paras tapa hallita muutoksia, haaroja ja paljon muuta.