Belge yazarları için Git

Belgelendirmeye katkıda bulunmak isteyen bazı kişiler, Fedora belgelendirmesine katkıda bulunmak için Git’i nasıl etkili bir şekilde nasıl kullanacaklarını bilemeyebilir. Bu belge bir miktar rehberlik sağlamayı amaçlamaktadır. Okuyucuyu bunaltmaktan kaçınmak için belli bir doğrultuda olması amaçlanmıştır.

Bu, yollardan bir tanesidir, tek yol değildir. Hedefleri gerçekleştirmenin tek yolu bu belgedeki talimatlar değildir. Bazı durumlarda, en iyi yol bile olmayabilirler, ancak çalışan bir yoldur. Bu, özellikle yeni git kullanıcılarını hedefler ve bu nedenle çok fazla seçenek veya tercih içermez. Git ile daha fazla tanıştıkça, sizin için en uygun olan yollara sapabilirsiniz.

Ön koşullar

Bu sayfadaki herhangi bir şeyi yapmak için aşağıdakilere sahip olmak isteyeceksiniz:

  • Bir Fedora Hesap Sistemi (FAS) hesabı

  • git (dnf install git)

  • Seçtiğiniz metin düzenleyicisi

  • Temel terminal deneyimi

  • (önerilir) Podman (dnf install podman)

Bu belge Fedora göz önünde bulundurularak yazılmış olmasına rağmen, aşağıdaki adımlar git’in kurulu olduğu herhangi bir işletim sisteminde çalışmaktadır. Diğer işletim sistemlerinde git kurulumu hakkında daha fazla bilgi için git belgelendirmesi sayfasını ziyaret edin.

İlk düzenlemenizi yapmadan önce

İlk başladığınızda, belgeler için git depolarına yazma (commit) erişiminiz olmayacaktır. "Çatal" adı verilen kendi kopyanızı oluşturmanız gerekecektir.

Resmi depo ile çatalınızı güncel tutmanız gerekecektir. Nasıl yapılacağı bu belgenin ilerleyen bölümlerinde ele alınmıştır.
Öntanımlı olarak git clone, komutu çalıştırdığınız dizinde bulunan, depo ile aynı isimde bir alt dizine bir depoyu klonlayacaktır. Dosya sisteminizi güzel ve düzenli tutmak için, tüm belgelendirme depolarınızı sakladığınız özel bir dizine sahip olmak isteyebilirsiniz. Örneğin: $HOME/fedora/docs
  1. Orijinal Pagure deposuna gidin

    1. Pagure’deki '''Clone''' açılır menüsünü tıklayın

    2. '''Git''' kutusunun içeriğini kopyalayın

    3. Bir terminalden, deponuzu saklamak istediğiniz dizine gidin. Örneğin: cd $HOME/fedora/docs. Eğer yoksa bu dizini oluşturmanız gerekecektir (örneğin: mkdir -p $HOME/fedora/docs)

    4. Bir terminalden git clone <GIT URL> -o upstream komutunu çalıştırın. Örneğin: git clone https://pagure.io/fedora-docs/quick-docs/ -o upstream.

  2. Pagure deposu çatalınızı oluşturun

    1. Çatalını oluşturmak istediğiniz Pagure deposuna gidin (örneğin https://pagure.io/fedora-docs/quick-docs/). Bundan sonra ''upstream'' deposu olarak bahsedilecektir.

    2. Üst kısımdaki '''Fork''' düğmesine tıklayın.

    3. Pagure’deki '''Clone''' açılır menüsünü tıklayın

    4. '''SSH''' kutusunun içeriğini kopyalayın

  3. Çatalınızı yerel çalışma deponuza ekleyin

    1. Bir terminalden, yukarıda klonladığınız dizine gidin. (Örneğin: cd $HOME/fedora/docs/quick-docs)

    2. O dizinden git remote add origin <SSH URL> komutunu çalıştırın. (Örneğin: git remote add origin ssh://git@pagure.io/forks/bcotton/fedora-docs/quick-docs.git)

Bu belge git komutları için terminal kullanmaktadır. Ancak, bir grafiksel git aracı kullanmayı da seçebilirsiniz. İş akışının kuralları aynıdır.

Her katkıda bulunmadan önce

Katkıda bulunmaya başlamadan önce, upstream deposuyla güncel olduğunuzdan emin olmak istersiniz. Bu, değişikliklerinizi en son sürümde yapacağınız anlamına gelmektedir.

  1. git checkout master komutunu çalıştırarak master dalınızda olduğunuzdan emin olun

  2. git pull komutuyla upstream değişikliklerini alın

Bu, düzenlediğiniz deponun ana dal olarak master ismini kullandığını varsaymaktadır. Bazı depolar farklı bir iş akışına sahip olabilir. Emin değilseniz ekibe danışın.
Çatal deponuzun web görünümünü kullanırsanız, güncellenen içeriği çatalınıza göndermek isteyeceksiniz. Bunu git push origin master komutuyla yapın.

Katkıda bulunma

Daha sonra çakışmaları temizlemeye çalışırken bir dal oluşturmuş olmayı istemektense ihtiyacınız olmasa bile yeni bir dal oluşturmak daha iyidir. En sıradan değişiklikler için bile dallar oluşturun ve potansiyel ıstıraplardan kurtulun.

Şimdi yapmak için buraya geldiğiniz katkıyı yapma zamanı. Üzerinde çalışmak için yeni bir dal oluşturarak başlamak isteyeceksiniz.

  1. git checkout -b ''dal_ismi'' (''dal_ismi'' sorun8-hataları_düzelt veya yazarlar_için_ipuçları_ekle gibi bir şeyler olabilir)

Bir dalı istediğiniz gibi adlandırabilirsiniz. Açıklayıcı isimler iyidir, özellikle de üzerinde birkaç faklı oturumda çalışacağınız bir şeyse. Doğrudan upstream deposu üzerinde çalışıyorsanız, benzersiz ve açıklayıcı bir dal adı kullanmak, diğer katkıda bulunanların dalınızın ne olduğunu bilmesine yardımcı olur.
Geçerli dalınızı git branch komutuyla öğrenebilirsiniz. Üzerinde olduğunuz dalın başında * işareti olacaktır. Mevcut başka bir dala geçmek isterseniz, git checkout ''dal_ismi'' komutunu kullanın.

Şimdi istediğiniz değişiklikleri yapabilirsiniz. En sevdiğiniz metin düzenleyicisini başlatın ve düzenlemelerinizi gerçekleştirin. İşiniz bittiğinde, sırada değişiklikleri depoya kaydetme (commit) var.

  1. git add ''düzenlediğiniz dosya(lar)''

  2. git commit

  3. Kayıt (commit) mesajını düzenleyin ve düzenleyiciden çıkın. Sisteminiz öntanımlı düzenleyici olarak vim kullanıyorsa (değiştirmediyseniz büyük olasılıkla öyledir), düzenleme moduna geçmek için i tuşuna basın. Kayıt mesajınızı yazmayı bitirdiğinizde Escape tuşuna basın, : wq yazın ve enter tuşuna basın.

İyi kayıt mesajları, birisi (gelecekteki siz dahil) ne yapıldığını görmek için depo kayıt geçmişine baktığında faydalıdır. İyi bir kayıt mesajı, neyin niçin yapıldığını anlatır.
Kayıt işlemlerinizi tek bir mantıksal değişiklikle ilgili tutmaya çalışın. Bu, gerekirse yapılanları geri almayı kolaylaştırır. "Tek bir mantıksal değişiklik" birden çok dosyanın düzenlenmesini gerektirebilir, bunların tümü tek bir kayıt işleminde olmalıdır, ancak alakasız içerikler ekliyorsanız, ayrı ayrı yapın.

Son olarak, değişikliklerinizi yerel makinenizden uzak sunucuya göndermenin ve çekme isteğini oluşturmanın zamanı geldi.

  1. git push origin ''dal_ismi''

  2. Web tarayıcınızdan çatal deponuza gidin (örneğin: https://pagure.io/fork/bcotton/fedora-docs/quick-docs)

  3. Bir çekme isteği oluşturmak için git sunucusunun talimatlarını izleyin (Pagure ve GitHub için belgeler)