Ana içeriğe geç

Octacity Docs nasıl kullanılmalı?

Octacity Docs, açık kaynak proje geliştirirken takıldığınızda veya bir işi nasıl yapılandıracağınızı bilemediğinizde doğrudan başvurabileceğiniz pratik ve açık fikirli bir bilgi tabanıdır.

Buradaki metinler katı kanunlar ya da bağlayıcı kurallar bütünü değildir. Her ekibin ve her projenin bağlamı farklıdır; dolayısıyla bu rehberdeki tavsiyeleri bir başlangıç standardı ve ortak akıl olarak ele almalı, kendi durumunuza göre sağduyunuzu kullanmalısınız.

Ne zaman başvurmalı?​

  • Yeni bir projeye başlarken kapsamı belirlemekte zorlandığınızda,
  • Bir GitHub Issue veya Pull Request açarken standart yakalamak istediğinizde,
  • Takım içinde görev paylaşımı ve iletişim tıkanıklığı yaşadığınızda,
  • Bir maintainer olarak gelen katkıları nasıl yöneteceğinizi planlarken.

Nasıl yaklaşmalısınız?​

  1. Duruma uyan en sade çözümü seçin: Projeniz 2 kişilik erken aşama bir projeyse, 50 kişilik ekiplerin bürokratik pratiklerini uygulamaya çalışmayın.
  2. Soruyu doğrudan cevaplayın: Bir rehberi okurken teorik tartışmalara boğulmak yerine, "şu anda ne yapmalıyım?" sorusuna yanıt arayın.
  3. Gerçek hayat tecrübesini üstün tutun: Projenizde uyguladığınız bir pratik buradaki öneriden daha iyi sonuç verdiyse, rehberi körü körüne takip etmek yerine deneyiminize güvenin.
  4. Katkı sağlayın: Eğer bir rehber eksikse, güncelliğini yitirmişse veya yeni bir tecrübe kazandıysanız, dokümantasyonu kod gibi ele alıp güncelleyin. Her rehber sayfasının en altında yer alan "Bu sayfayı düzenle" bağlantısını kullanarak doğrudan o sayfanın Markdown kaynağına ulaşabilir veya octacity-org/octacity-docs deposunu forklayıp bir Pull Request açabilirsiniz. Ayrıntılı katkı adımları ve şablonlar için projedeki CONTRIBUTING.md belgesini inceleyin.

İyi bir kullanım örneği​

Bir geliştirici, projesine gelen büyük bir PR karşısında ne yapacağını bilemediğinde Maintainer Ne Yapar? ve Code Review Nasıl Yapılır? rehberlerine bakar. Oradaki kontrol listesini ve etiketleme standartlarını referans alarak PR sahibine yapıcı, net ve gerekçeli bir geri bildirim iletir.

Sık yapılan hatalar​

  • Rehberleri kural kitabı sanmak: "Dokümantasyonda böyle yazıyor, o yüzden başka türlü yapamayız" demek açık kaynak ruhuna ve esnekliğe aykırıdır.
  • Tüm rehberleri baştan sona ezberlemeye çalışmak: Octacity Docs baştan sona roman gibi okunmak için değil, sorun anında aranıp bulunacak modüler bir kılavuz olarak tasarlanmıştır.

Daha fazla bilgi​

Octacity'nin kurumsal ve bağlayıcı politikaları için:
octacity-org/.github