Github’ımız Nasıl Daha İyi Hale Getirilir? Profil Nasıl Hazırlanır? README Nasıl Yazılır?

Github’ımız Nasıl Daha İyi Hale Getirilir? Profil Nasıl Hazırlanır? README Nasıl Yazılır?

Herkese merhaba! Bu yazıda, GitHub/GitLab profillerimizi, repolarımızı ve README dosyalarımızı nasıl daha etkili ve profesyonel hale getirebileceğimizi ele alacağım. Bunun yanı sıra, neden bu kadar önemli olduklarına dair bilgiler paylaşacağım. GitHub Nedir? / GitLab Nedir? gibi temel soruların ötesine geçerek, birçok kişinin gözden kaçırdığı ancak global ölçekte oldukça önemsenen noktalara değineceğim.

Github Nedir? Gitlab Nedir?

Bu konulara detaylıca değinmeyeceğim, ancak merak edenler için birkaç kaynağı aşağıya bırakıyorum:

• Git, GitHub, GitLab Nedir? Git Komutları — Tuğçe Akın
• Git Nedir? GitHub Kullanımı ve Temel Seviye Komutlar — İrem Ateş

GitHub veya GitLab Profilimiz Neden Önemli?

Bu sorunun cevabı oldukça basit: Profiliniz, yazılım dünyasındaki dijital CV’nizdir. Günümüzde, ister kurumsal bir işe başvuruyor olun ister freelance çalışıyor olun, sunduğunuz CV (özgeçmiş) veya portföy, yeteneklerinizi ve deneyimlerinizi sergilemenin en önemli araçlarından biri. Yazılım dünyasında ise, bu portföyün en etkili hali GitHub veya GitLab profilinizdir.

Dahası, GitHub üzerinden iş bulma imkanları, profillerinizin içeriklerini çok daha önemli hale getiriyor. Bu nedenle, sadece profilinizin değil, yönlendirdiğiniz repoların da düzenli, anlaşılır ve profesyonel bir yapıda olması gerekiyor. Profiliniz ve repolarınız, sizi tanıtan ve yeteneklerinizi yansıtan en güçlü araçlardır.

Peki bunu nasıl yapacağım?

Öncelikle, GitHub profiliniz aşağıdakine benzer bir yapıda ise daha önce profiliniz için bir README.md dosyası, yani kendi kullanıcı adınızla bir repository oluşturulmamış demektir. Şimdi, birlikte kendi kullanıcı adımızla bir repository oluşturalım. :)

Varsayılan Github Profile Görünümü

Normal bir repository oluşturur gibi işlem yapıyoruz. Repository name alanına GitHub kullanıcı adımızı yazıyoruz. GitHub, bu adı algılayarak bize özel bir profil repository’si oluşturacağımızı otomatik olarak tanıyor. Ardından, alt seçeneklerden Add a README file seçeneğini işaretleyerek repository’yi oluşturuyoruz.

Repository Oluşturma Aşaması

Readme Oluşturulmuş Repository Görünümü

Readme Oluşturulmuş Profil Görünümü

Repository’yi oluşturduktan sonra, repository’niz görseldeki gibi (Sol) bir yapıya sahip olacaktır. Profiliniz ise görseldeki gibi (Sağ) bir görünüm kazanacaktır.

Artık profil README’nizi doldurma ve güzelleştirme zamanı geldi. Peki, bunu nasıl yapacağız? Hemen bir şeyler yaratmak zor olabilir, ancak bunu kolaylaştıracak araçlar mevcut. 😎

Github Profilimi Nasıl İyi Hale Getiririm? Nasıl doldurabilirim?

Aslında bunun için bir çok araç olduğundan yazının yukarısında bahsetmiştim. Bu yüzden endişe edeceğimiz bir durum yok. Hatta kötü olduğunu düşünüyorsanız bile iyi yapacak fikirler için bile websiteler mevcut. Bu araçlara gelecek olursak ;

1. Github Profile Readme Generator: Belki de en basit, kullanımı kolay ve en çok bilinen araçlardan biri olduğunu söyleyebilirim. Rahuldkjain tarafından geliştirilen bu güzel açık kaynak proje, seçimlerinizi yaparak ve birkaç temel bilgiyi doldurarak profilinizi oluşturmanızı sağlıyor. Proje, ilk başlarda standart şablonlar üzerinde çalışıyordu, ancak günümüzde Medium veya Dev.to yazılarınızı bile otomatik olarak profilinize eklemenizi sağlayan bir eklenti ile birlikte geliyor.
2. Profilinator: Rishav’ın geliştirdiği bu araç ise basit bir editor aracılıyla yapmış olduğunu stili ve tasarımları değiştirebiliyorsunuz. Örneğin sayfayı 3’e bölmek gibi. Yine burada Medium veya Dev.to yazılarınızı otomatik olarak ekleyebilirsiniz.
3. GPRM: Rahul’un yaptığından farklı olarak bu aracımızda bazı stillemeler ve özellikleri daha kolay olarak seçerek tercih edebiliyor farklı bir tasarım dili ortaya çıkartabiliyorsunuz.

Eğer ki araç kullanmak istemiyorum. Stilleri merak ediyorum kendim de ona göre yapacağım derseniz;

Awesome Github Profile

• Awesome Github Profile: Burada ise farklı yazılım geliştiricilerin kendi sayfalarını paylaştığı ve stil tarz anlamında farkılıkları görebileceğiniz ve esinlenip kendinize uyarlayabileceğiniz mükemmel bir site.

Github Repolarımız Neden Önemli?

Repolarımız bizim yapmış olduğumuz öğrendiğimiz her teknolojinin, her projenin veya yapmış olduğumuz küçük PoC(Proof of Concept)’ler barındırması dolayısıyla önem arz ediyor. Çünkü burada yapmış olduğumuz projeler bir konu hakkında bilgimizi, kod yazma kalitemizi, yapısal bilgilerimizi veya en azından o konu ile alakalı aşinalığımızı ispatlar nitelikte olmuş oluyor. Örneğin; Bir mülakatta “A Framework’ünü kullanmayı biliyorum” demeniz ile “A Framework’ü ile bir kaç temel projeye sahibim” demeniz arasında dağlar kadar fark var. En basit haliyle size devamında gelecek sorular genellikle hakim olduğunuz yerlerden olacaktır. Çünkü klasik tabir ile elinizi hamura buladınız.

Bu repoların bir diğer önemi, projelerinizin hangi standartlara uygun olarak geliştirildiğini göstermesidir. Hangi şirkete giderseniz gidin, belirli standartlara uyum sağlamanız beklenecektir. Örneğin, git commit mesajlarınızın anlamlı ve belli bir yapı çerçevesinde olması beklenir. Çoğu açık kaynak projede Conventional Commits yapısı tercih edilir ve siz de commit mesajlarınızı bu standartlara uygun hale getirebilirsiniz. Ayrıca, versiyonlama için Semantic Versioning gibi bir yapıyı öğrenmek ve uygulamak da oldukça faydalı olacaktır. Bu tür yaklaşımlar, projenize verdiğiniz önemi ve profesyonelliğinizi yansıtır.

Github Repolarımızın Görünümü Nasıl İyi Yapabiliriz?

Bir projenin iyi bir izlenim bırakması için en önemli unsurlardan biri README dosyasıdır. İyi bir README dosyası, projeyi anlamayı ve kullanmayı kolaylaştırır. Aşağıdaki başlıklar, README’nizi daha etkili hale getirmek için bir rehber niteliğindedir:

• Proje Adı: Projenin kimliğidir ve ilk izlenimi oluşturur. Projenizi tanımlayan kısa ve anlaşılır bir başlık seçin. Örneğin, “Hava Durumu Tahmin Uygulaması” gibi.
• Projenin Amacı: Projenizin ne işe yaradığını, hangi sorunu çözdüğünü veya hangi ihtiyacı karşıladığını kısa ve öz bir şekilde açıklayın. “Bu proje, kullanıcılara gerçek zamanlı hava durumu bilgileri sağlamayı amaçlamaktadır. Basit ve kullanıcı dostu bir arayüzle şehir bazlı tahminlere ulaşabilirsiniz.”
• Projenin Özellikleri: Projenizin temel özelliklerini listeleyin. Kullanıcılar bu bölümde projenizin neler sunduğunu öğrenebilir.Şehir bazlı hava durumu tahminiGerçek zamanlı güncellemelerKullanıcı dostu arayüz
• Kurulum Talimatları: Projenizin nasıl kurulacağını ve çalıştırılacağını adım adım açıklayın. Teknik bilgi seviyesi farklı olan kullanıcılar için basit bir rehber oluşturun.

1. Depoyu klonlayın:
  `git clone <https://github.com/kullaniciadi/proje-adi.git>`
2. Gerekli bağımlılıkları yükleyin:
  `npm install`
3. Uygulamayı başlatın:
  `npm run dev`

• Kullanım Kılavuzu: Projenizin nasıl kullanılacağını açıklayın. Bu bölümde örnek ekran görüntüleri veya komutlar paylaşabilirsiniz. “Ana sayfadan bir şehir seçerek hava durumunu görüntüleyebilirsiniz.”
• Katkıda Bulunma : Projenize nasıl katkıda bulunulabileceğini açıklayın. Kullanıcıların projeye dahil olması için rehberlik sunun.

- 🛠 Bu projeyi fork edin
- Değişikliklerinizi yapın
- Bir pull request gönderin

• Lisans: Projenizin lisansını belirleyin. Bu, kullanıcıların projenizi nasıl kullanabileceğini ve değiştirebileceğini açıklar. Örneğin: “”Bu proje MIT Lisansı ile lisanslanmıştır. Daha fazla bilgi için LICENSE dosyasına bakabilirsiniz.”

Genel olarak bir README dosyası 7–8 ana başlık altında yapılandırılır, ancak bu başlık sayısı, projenizde vermek istediğiniz detaylara göre değişiklik gösterebilir. Markdown bilginiz olmasa bile, aşağıda paylaştığım birkaç kullanışlı araç sayesinde repolarınızı daha anlaşılır ve estetik hale getirebilirsiniz:

• Detaylarla uğraşmak istemeyenler için: Eğer sadece birkaç tuşlama ile hazır bir yapı oluşturmak istiyorsanız, CLI tabanlı bir araç olan Readme MD Generator tam size göre! Bu araç, temel bilgileri doldurarak hızlıca bir README oluşturmanızı sağlar.
• Sürükle-bırak yöntemiyle çalışanlar için: Eğer daha görsel ve pratik bir çözüm arıyorsanız, readme.so, ihtiyacınızı karşılayabilir. Sadece bilgilerinizi güncelleyerek kısa sürede şık bir README oluşturabilirsiniz.
• Her şeyi kendisi yapmayı sevenler için: Eğer “Ben old school’um, her şeyi kendim yaparım, README’mi de kendim yazarım” diyorsanız, makeareadme.com sizin için ideal bir kaynak. Burada README yazmanın neden önemli olduğunu öğrenebilir ve yazım sürecini destekleyecek bir editör kullanabilirsiniz.
• Farklı projelerden ilham almak isteyenler için: Eğer “Diğer projeler bunu nasıl yapıyor?” diye merak ediyorsanız, Awesome README tam da bu ihtiyaca yönelik. NASA’nın OGMA projesi gibi birçok farklı projeden örnek README dosyalarını inceleyerek ilham alabilirsiniz.

GitHub Repository’lerinizde Sadelik ve Düzen Nasıl Sağlanır?

GitHub projelerinizin hem estetik hem de işlevsel açıdan daha düzenli görünmesi, diğer kullanıcıların projeyi anlamasını ve kullanmasını kolaylaştırır. Aşağıda bu süreci adım adım açıklıyorum.

1. Repository Detaylarını Düzenleyin

Görsel 1-2'de olduğu gibi, repository bilgilerinizi düzenlemek için üst kısımdaki “Settings” sekmesine giderek detayları doldurabilirsiniz.

Eylemler:

• Description (Açıklama): Kısa bir cümle ile projenizin amacını yazın. (Örn: “Hava Durumu Uygulaması”)
• Website: Eğer projenize ait bir demo veya dökümantasyon linki varsa buraya ekleyin.
• Topics: Projenizin kategorilerini (örn: vue3, gpt-4) ekleyerek arama sonuçlarında daha görünür hale getirin.

Neden Önemli?Bu bilgiler, proje sayfasını ziyaret eden kullanıcıların proje hakkında hızlıca bilgi edinmesini sağlar. Ayrıca doğru doldurulmuş bir açıklama, arama motorlarında projenizin daha kolay bulunmasına katkı sunar.

2. Gereksiz Alanları Kapatın

Eğer projenizde bir Release, Package ya da Deployment kullanımı yoksa, bunları devre dışı bırakabilirsiniz (Görsel 1–2).

Eylemler:

• “Edit repository details” menüsünden ilgili kutucukları işaretleyerek ya da kaldırarak gereksiz özellikleri kapatın.

Neden Önemli?Boş veya kullanılmayan alanlar, repository’nin gereksiz kalabalık görünmesine neden olabilir. Sadece aktif olarak kullanılan özellikleri açık bırakmak, projenize sadelik ve profesyonellik katar.

3. Özelleştirme için Wiki, Issues ve Projects Ayarları

Görsel 3 ve Görsel 4'da gösterildiği gibi, Wiki, Issues ve Projects özelliklerini projenizin ihtiyaçlarına göre açıp kapatabilirsiniz.

Eylemler:

• Wiki: Eğer proje için dökümantasyon yazmak istiyorsanız açık bırakın. Sadece proje ekibinin düzenlemesine izin vermek için “Restrict editing to collaborators only” seçeneğini işaretleyin.
• Issues: Eğer projeye katkı sağlanmasını istiyorsanız bu alanı açık bırakın. Ayrıca, düzenli takip için bir Issue Template ekleyebilirsiniz.
• Projects: Projeye özel görevlerinizi ve takvimlerinizi burada yönetmek istiyorsanız açık bırakabilirsiniz.

Neden Önemli?Bu alanların ihtiyaçlara göre yönetilmesi, repository’nin daha düzenli ve hedef odaklı olmasını sağlar. Kullanılmayan özellikler, gereksiz karmaşaya neden olur.

4. Doldurulması Gereken Alanları Atlamayın

Repository’nizin About bölümündeki boşluklar veya eksik bilgiler (örneğin Description, Topics) repository’nin eksik ve ilgisiz görünmesine yol açabilir.

Eylemler:

• Tüm gerekli alanları doldurun.
• Projenizle uyumlu bir açıklama ve etiketler kullanarak profesyonel bir görünüm elde edin.

Neden Önemli?Eksik bilgiler, kullanıcıların proje hakkında bilgi edinmesini zorlaştırır ve repository’nin amatör görünmesine neden olabilir.

5. Dil Kullanımı ve Görsellik

Repository’nizde kullanılan programlama dillerini temsil eden Languages kısmı, projeyi inceleyen kişilere kod yapınız hakkında bilgi verir. Ayrıca README’nizi etkili görsellerle destekleyerek projenizi daha çekici hale getirin.

Eylemler:

• README dosyasına proje yapısını ve kullanımını anlatan ekran görüntüleri ekleyin.
• Kod snippet’leriyle örnek kullanım talimatlarını gösterin.

Neden Önemli?Hem yazılı hem görsel açıklamalar, kullanıcıların projeyi daha hızlı anlamasına yardımcı olur ve katkıda bulunmalarını teşvik eder.

6. Sonuç: Daha Özgün ve Sade Bir Repository

Bu adımları uygulayarak, GitHub repository’nizi gereksiz detaylardan arındırabilir, daha profesyonel ve kullanıcı dostu bir görünüm kazandırabilirsiniz. Düzenli ve güncel bir proje sayfası, projenizin genel görünümünü ve kalitesini hızlıca değerlendirmek isteyen kullanıcılar için büyük önem taşır. Sadelik ve işlevsellik, hem kullanıcıların ilgisini çeker hem de katkı sağlamak isteyenler için motive edici bir etki yaratır.

Unutmayın, iyi tasarlanmış bir repository, projenizi anlatmanın ve topluluğun ilgisini çekmenin en etkili yoludur! — ChatGPT

Bu yazıda, GitHub/GitLab profillerinin ve README dosyalarının önemine odaklanarak, bunları nasıl daha iyi hale getirebileceğinizle ilgili önemli noktaları ve araçları paylaştım.

Sorularınız veya önerileriniz varsa, LinkedIn hesabımdan bana ulaşabilirsiniz. Diğer hesaplarıma ise Bento.me/eralpozcan veya eralpozcan.dev üzerinden erişebilirsiniz. 🤖

Beni Githubdan takip etmeyi ve yorumlara Github adreslerinizi bırakmayı unutmayın 🎁

Bir sonraki yazıda görüşmek üzere! 📩