Belgelere Katkıda Bulunma

Belgelere katkıda bulunmak, başkalarının framework'ü anlamasına yardım ettiği için en değerli etkinliklerden biridir.

Nasıl Yazmalı?

Belgeler öncelikle konuya yeni olan kişiler içindir. Bu yüzden birkaç önemli noktayı karşılamalıdır:

• Basit ve genel kavramlarla başlayın. Daha ileri konulara ancak sonda geçin.
• Konuyu olabildiğince anlaşılır anlatmaya çalışın. Örneğin önce bir meslektaşınıza anlatmayı deneyin.
• Yalnızca kullanıcının o konu için gerçekten gereksinim duyduğu bilgiyi verin.
• Bilginizin doğru olduğunu doğrulayın. Her kod parçasını sınayın.
• Özlü olun; yazdığınızı yarıya indirin. Sonra çekinmeden bunu bir kez daha yapın.
• Vurgulamayı, kalın metinden .[note] gibi kutulara dek, ölçülü kullanın.
• Kod örneklerinde Kodlama standardını izleyin.

Ayrıca sözdizimini öğrenin. Yazarken makaleyi önizlemek için önizleme düzenleyicisini kullanabilirsiniz.

Dil Sürümleri

İngilizce birincil dildir, dolayısıyla değişiklikleriniz ideal olarak İngilizce olmalıdır. İngilizce güçlü yanınız değilse DeepL Translator kullanın; başkaları metninizi gözden geçirecek.

Diğer dillere çeviri, düzenlemeniz onaylanıp sonlandırıldıktan sonra otomatik yapılacak.

Önemsiz Düzenlemeler

Belgelere katkıda bulunmak için GitHub üzerinde bir hesabınızın olması gerekir.

Belgelerde küçük bir değişiklik yapmanın en kolay yolu, her sayfanın sonundaki bağlantıları kullanmaktır:

• Show on GitHub sayfanın kaynak sürümünü GitHub'da açar. Sonra düzenlemeye başlamak için E tuşuna basmanız yeter (GitHub'da giriş yapmış olmalısınız).
• Open preview nihai görsel görünümü hemen görebileceğiniz bir düzenleyici açar.

Önizleme düzenleyicisi değişiklikleri doğrudan GitHub'a kaydedemediğinden, düzenlemelerinizi bitirdikten sonra kaynak metni panoya kopyalamanız (Copy to clipboard düğmesiyle) ve sonra GitHub'daki düzenleyiciye yapıştırmanız gerekir. Düzenleme alanının altında bir gönderme formu vardır. Burada düzenlemenizin nedenini kısaca özetlemeyi ve açıklamayı unutmayın. Gönderdikten sonra, daha sonra da düzenlenebilen bir pull request (PR) oluşturulur.

Daha Büyük Düzenlemeler

Yalnızca GitHub arayüzüne dayanmak yerine, Git sürüm denetim sistemiyle çalışmanın temellerini bilmek daha iyidir. Git'e aşina değilseniz git – the simple guide kaynağına başvurabilir ve mevcut pek çok grafik istemciden birini kullanmayı düşünebilirsiniz.

Belgeleri şöyle düzenleyin:

1. GitHub'da bir fork oluşturun; yani nette/docs deposunun bir kopyasını kendi hesabınıza alın.
2. Bu depoyu bilgisayarınıza klonlayın.
3. Sonra uygun dalda değişiklikleri yapın.
4. Metindeki fazladan boşlukları Code-Checker aracıyla denetleyin.
5. Değişiklikleri kaydedin (commit).
6. Değişikliklerden memnunsanız, onları GitHub'da kendi fork'unuza gönderin (push).
7. Oradan bir pull request (PR) oluşturarak nette/docs deposuna sunun.

Öneriler içeren yorumlar almak olağandır. Önerilen değişiklikleri izleyin ve onları uygulayın. Önerilen değişiklikleri yeni commit'ler olarak ekleyin ve yeniden GitHub'a gönderin. Var olan bir pull request'i değiştirmek için asla yeni bir pull request oluşturmayın.

Belgelerin Yapısı

Belgelerin tamamı GitHub'da nette/docs deposunda bulunur. Güncel sürüm master dalında, daha eski sürümler ise doc-3.x, doc-2.x gibi dallardadır.

Her dalın içeriği, tek tek belge alanlarını temsil eden ana klasörlere bölünmüştür. Örneğin application/ klasörü https://doc.nette.org/en/application adresine, latte/ klasörü https://latte.nette.org adresine karşılık gelir vb. Bu klasörlerin her biri, dil sürümlerini temsil eden alt klasörler (cs, en, …) ve isteğe bağlı olarak, belge sayfalarına eklenebilen görselleri içeren bir files alt klasörü barındırır.