Mevcut bir projeyi nasıl hazırlayıp GitHub’a yüklerim?
Bu ünitede, GitHub'a proje yükleme konusunda dikkat edilmesi gereken önemli noktalar ele alınıyor.
Neden GitHub’a yükleme yapılır?
GitHub'ın faziletlerinden bahseden çok sayıda edebiyat vardır ve sizi katılmaya ikna etmek bu modülün kapsamının dışındadır. Ancak bu modülde, karşıya yüklemenizi planlarken göz önünde bulundurmanız gereken konular bağlamındaki bazı önemli avantajları ele alacağız.
Sürüm denetimi
GitHub, muhtemelen en iyi sürüm denetimi sistemi olan Git'i özel olarak kullanır. Ancak Git son derece karmaşıktır ve ekibinizin karşılaşılmayabileceği kodlarla çalışmak için bazı karmaşık senaryolar oluşturabilir. Dallar ve çekme istekleri Git kullanan geliştiriciler için günlük yaşamın temel bir parçasıdır, bu nedenle GitHub'da başarılı olmak için bunların ne zaman ve nasıl etkili bir şekilde kullanılacağını anlamak gerekir. Ekibinizin ilk olarak GitHub akışına aşina olması ve böylece çalışmaya devam edebilmeniz faydalı olacaktır.
Kodunuzu bulutta tutma
Büyük miktarda proje kodu hala yalnızca geliştirici makinelerinde depolanır. GitHub'a yüklediğinizde kodunuzu GitHub'ın bulut platformuna taşırsınız ve ekip üyeleri bu platforma her yerden kolayca erişebilir. Bu değişiklik, sürüm denetiminde tuttuğunuz dosya ve veri türlerine yönelik takımınızın politikasını gözden geçirmek için iyi bir fırsat sunar. En iyi uygulama olarak GitHub'a taahhüt ettiğiniz her şeyin tehlikeye girmiş olma olasılığı olduğunu varsaymalısınız. Bu nedenle API anahtarları, parolalar veya karşılaştırılabilir bilgiler içeren diğer dosyalar gibi hassas verileri eklememeye dikkat edin.
Not
GitHub, bir deponun farklı bölümleri için hem genel hem de özel depolar ve ayrıntılı erişim denetimleri sunar. Bu ayrıntı düzeyi, projelerinizin kimlere görünür olduğunu ve belirli bir kullanıcının hangi eylemleri gerçekleştirebileceğini denetlemenize olanak tanır.
İşbirliği
GitHub; sorunlar, çekme istekleri ve kod incelemeleri gibi özellikler aracılığıyla takım işbirliği için mükemmel destek sunar. Ancak GitHub akışı, ekibinizin şu anda alışkın olduğu uygulamalardan farklı olabilir. Ekibinizin GitHub'a nasıl uyum sağlayabileceğini ve mevcut işlemleri korumanız gerekip gerekmediğini göz önünde bulundurmanız iyi bir fikirdir.
Projeniz dışarıdan katkıda bulunanlara izin veren açık kaynak bir projeyse, bu avantajları en üst düzeye çıkarmak için GitHub'dan daha iyi bir seçenek yoktur.
GitHub'a yükleme
Planla ilgili dikkat edilmesi gerekenler
GitHub’a yüklemenizi yürütmeden önce dikkate alınacak en önemli şey, mevcut kaynak durumunuzun dışında bir şeyi korumanız gerekip gerekmediğidir. Örneğin, düzeltmeyi planladığınız hataları izlemek için bir elektronik tablo veya proje yönetimi yazılımı kullanabilirsiniz. Bu öğelerin geçirilmesine yönelik destek platforma göre değişir ve topluluk projelerinden genel olarak kullanılabilir. Bu modül, bu tür verilerin geçirilmesini kapsamaz.
Projenizde şu anda depolanan ikili dosyaları işleme
En iyi uygulama olarak GitHub depoları, projeleri derlemek için gerekli olan dosyalarla sınırlı olmalıdır. Derleme yapıtları gibi büyük ikili dosyalarla commit işlemi yapmaktan kaçının. Elektronik tablolar ve sunumlar gibi ikili dosyalar, nasıl sunulacağını ve nasıl düzgün şekilde sürümünün oluşturulacağını anlayan portallarda izlenmeye daha uygundur. Büyük ikili dosyaları sürüme almanız gerekiyorsa Git LFS (Büyük Dosya Depolama) Git uzantısını kullanmayı göz önünde bulundurun.
.gitignore gibi önemli Git dosyaları oluşturma
Git, sürüm denetimi dosya ilkelerini zorunlu kılmaya yardımcı olmak için dosyaları destekler .gitignore . Bu dosyalar, dosyaları ve klasörleri kaynak denetimi izlemesinin dışında tutmak için kullanılan arama desenlerini tanımlar. Aşağıdaki örnek, herhangiBin veya bin adlı klasörleri ve bunların içeriğini kaynak kontrol takibinin dışında tutar.
[Bb]in/
Dosyaları Yoksaymak hakkında daha fazla bilgi edinin.
.gitignore çeşitli platformlar için sunulan başlangıç dosyaları koleksiyonuna da göz atın.
Depo tüketicilerine ve katkıda bulunanlarına farklı ilkeleri açıklamak için GitHub projelerinde yaygın olarak kullanılan birkaç dosya daha vardır. Projeniz özel ve sınırlı bir hedef kitleyle sınırlı olsa da, yine de bu ilkeleri açıkça dile getirmek faydalı olabilir. Bu dosyalardan hiçbiri gerekli olmasa da, yaygın dosyalardan bazıları burada listelenmiştir.
| Dosya | Amaç |
|---|---|
README.md |
Dizinin giriş sayfası. Dizin GitHub’da görüntülenirken bu sayfa işlenir. |
LICENSE.md |
Bu dosya, kodun sağlandığı lisansı içerir. |
CONTRIBUTING.md |
Kullanıcıların projeye nasıl katkıda bulunması gerektiğini (ör. çekme isteği beklentileri) açıklar. |
SECURITY.md |
Projenin güvenlik ilkesini açıklar. Bu dosya, ele alınmadan önce genel olarak açıklanmaması gereken güvenlikle ilgili hassas kod veya geri bildirim göndermek isteyen kullanıcılara rehberlik sağlar. |
Projenizi sağlıklı katkılar için ayarlama hakkında daha fazla bilgi edinin.
Projenizi GitHub'a yükleme
Deponuz karşıya yüklenmek üzere hazırlandıktan sonra GitHub'da bir depo oluşturun. Oluşturulduktan sonra GitHub deponuzun Kod sekmesine gidin. Bu görünüm, proje kodunuzu karşıya yüklemenin çeşitli yollarını sağlar.
Kaynağınızı karşıya yüklemek için git istemcisini veya Git kullanımı kolay bir aracı kullanmanızı öneririz. Alternatif olarak, yeni dosya oluşturma bağlantısını kullanarak dosyalarınızı el ile karşıya yükleyebilirsiniz. Uzun vadede git istemcisi kullanmanın değişiklikleri, dalları ve daha fazlasını yönetmenin en iyi yolu olduğunu fark edebilirsiniz.