SpongeDocs’un Yazıları

Uyarı

This documentation refers to an outdated SpongeAPI version and is no longer actively maintained. While the code examples still work for that API version, the policies, guidelines, and some links may have changed. Please refer to the latest version of the documentation for those.

“Sponge Dosyaları” olarak da bilinen Sponge dokümantasyonu, Sponge projesinin resmi belgeleridir. SpongeDocs’un amacı şudur:

  • Kullanıcıların bir Sponge uygulamasıyla güçlendirilmiş öz sunucularını kurmalarına yardımcı olur.
  • Geliştiricilere, Sponge projesine nasıl katkıda bulunacakları konusunda bilgi verin.
  • Geliştiricilere, eklenti geliştirmeye başlama konusunda bilgi verin.

Sorunları bildir

Her zaman bir sayfanın modası geçmiş, bir hata gizlice giriyor ya da yalnızca bir sayfaya bakıp “Peki, bunu açıklamak için daha iyi bir yol var” diye düşünüyorsunuzdur. Durum böyle ve siz, kendinizce bir düzeltme sağlayamıyorsanız, sorunun farkına varmamızın üç yolu var:

  1. SpongeDocs GitHub’da Bir Konu Oluştur <https://github.com/SpongePowered/SpongeDocs/issues> `_
  2. SpongeDocs Forum Kategorisinde Bir Gönderi Oluştur <https://forums.spongepowered.org/c/sponge-docs> _
  3. Irc.esper.net adresindeki #spongedocs kanalında bizi ziyaret edin <ircs: //irc.esper.net: 6697 / # spongedocs> `_ (kaydolmanız gerekiyor)

Dokümanları Yazma

SpongeDocs’a yapılan değişiklikler ve eklemeler, çekme isteği olarak GitHub’daki SpongeDocs havuzuna <https://github.com/SpongePowered/SpongeDocs> `_ gönderilmelidir. Çekme taleplerinin gözden geçirme işlemi sırasında rafine edilmesi yaygın olduğu için hemen mükemmel olmasını gerektirmiyoruz. Eksik açıklamalar da açıktır, anlamak istemediğiniz bazı parçalar varsa utangaç olmayın. Boşlukları doldurabilecek her zaman biri olacak.

Dokümanlar reStructuredText (reST) ile yazılmıştır, Markdown’a (md) aşina iseniz, reST adımının zor olmaması gerekir. Onunla ilgili sorun yaşıyorsanız, forumlarımıza <https://forums.spongepowered.org/> _ veya #SpongeDocs <ircs: //irc.esper.net: 6697 / # spongedocs> katılmanızı öneririz. `_ Esper.net’te yardım isteyin.

Sünger dokümanları, ‘Creative Commons - Lisanslı Kullanım Lisansı’ kapsamında lisanslanmıştır. <Https://creativecommons.org/licenses/by-sa/4.0/> `. Sanat varlıkları, ilgili ‘Creative Commons - Ticari Olmayan, Türev Olmayanlar lisansı’ altında tutulmaktadır <https://creativecommons.org/licenses/by-nc-nd/4.0/> `. Katkılar, bu lisanslamayı örtülü olarak kabul eder.

Stil rehberi

Tüm SpongeDocs sayfalarında tutarlı bir formata sahip olduğumuzdan emin olmak için, Sponge Documentation yazarken geliştirdiğimiz yönergeler aşağıda belirtilmiştir. Dokümanlar büyüdükçe bu liste eklenebilir (şekli değişmiş olabilir).

  1. Başlıklar Başlık Olgusunda Yazılmalıdır (<- example) [# 8 geçerliyse].
  2. Sayfa başlıkları anlamlı olmalıdır (başlığı bir bağlantı olarak görürsünüz).
  3. Program kodu inline literals <http://docutils.sourceforge.net/docs/ref/rst/roles.html#literal> __ veya kod bloklarında bulunmalıdır.
  1. Kod bloklarına çok fazla metin koymamaya çalışın çünkü bunlar çevrilemezler. Katkıda bulunanlar kod bloklarında mümkün olduğunca yorum yapmaktan vazgeçtiler. Bazı örneklerde basit yer tutucu metin gerekli olabilir. İdeal olarak, kod bloğu örnekleri kısa olmalı ve gövde metnindeki her örnek için bir açıklama izlemelidir. Tabii ki, kısa bir örnekle gösterilemeyen bazı kavramlar olabilir.
  1. Kullanıcılar için ayrı alanlar tutun, Plugin devs ve Sponge Devs gibi.
  2. Mümkün olduğunca sayfaları paylaşarak tekrarlardan kaçının.
  3. Harici kaynaklara bunları üretmek yerine bağlayın.
  1. Bazı istisnalar çeviri amacıyla yapılır.
  1. SpongeForge, SpongeVanilla ve SpongeAPI arasında ayrım yapın.
  2. Kendi dilinizde kötü görünüyorsa, kendi kurallarınızı bulun.
  3. Sponge, Proje Başlığıdır ve çevrilmemelidir.
  1. Bazı diller de fonetik bir çeviriyi kullanmak isteyebilir.
  1. Otomatik çeviriler (örneğin Google Çeviri) kesinlikle önerilmemektedir. Bunlar genellikle ciddi hatalar içeriyor ve reddedilecek gibi görünüyor.
  2. Sayfa Başlıkları ve Bölüm Başlıkları, düz metin olmalı, karakter blokları ve diğer biçimlendirmelerden kaçınılmalıdır.
  3. Kod sembolleri orijinal formunda büyük harfle yazılmalı ve fazladan boşluklar içermemelidir (ör. BlockState (alan adı) veya BlockState (sınıf adı), * block state * yerine). Ayrıca, gövde metninde çift sırt kullanan (örn. “BlockState”) bir harf biçiminde biçimlendirilmelidirler.
  4. Satırların maksimum uzunluğu 120 karakter olmalıdır.
  5. İçeri aktarma, her bir makalede ilk kez başvurulduğunda kod bloklarında yazılmalı, ancak ilk defadan sonra tekrar edilmemelidir.

Not

Sponge devamlı değişen bir projedir, gelişme dokümanlarının eksikliği beklenmelidir. Sponge resmi olarak yayımlanıncaya kadar pek çok konuda boşluk olduğundan emin olabilirsiniz. Bununla birlikte, SpongeDocs canlı bir belgedir ve daima düzenlemeye tabidir. Hiçbir zaman kusursuz olamayacak, sadece talep doğrultusunda değişecektir.

Contributions, suggestions and corrections are always welcome.