Ana içeriğe geç

Yazı standardı

GuildGate belgeleri kaynak kod, test veya yayımlanmış arayüz üzerinden izlenebilen davranışları anlatmalıdır.

  • Public API adlarını, error code değerlerini ve contract sabitlerini değiştirmeyin.
  • Güncel kararlı sürüm ile tarihsel migration örneklerini ayırın.
  • Güvenlik sınırını açık yazın; test edilmiş bir kontrolü mutlak garanti gibi sunmayın.
  • İngilizce ve Türkçe sayfaların teknik anlamını eşit tutun.
  • Kod örneklerini yayımlanan export yollarıyla çalıştırın ve gerçek kimlik bilgisi kullanmayın.
  • Sürüm notlarında kullanıcıyı etkileyen davranış, uyumluluk, migration ve doğrulama sonuçlarını yazın.
  • Bir iddia doğrulanamıyorsa kapsamını daraltın veya kalan manuel kontrolü belirtin.