Ana içeriğe geç

.github ile Octacity Docs arasındaki fark nedir?

Kısa ve net ayrım şudur:

.github, Octacity'nin nasıl yönetildiğini ve işlediğini belirler.
Octacity Docs, topluluk üyelerinin daha kaliteli açık kaynak projeler inşa etmesine rehberlik eder.

Bu iki kaynak birbirinin alternatifi veya kopyası değildir; tamamen farklı sorumluluk alanlarına hizmet ederler.

İki kaynağın karşılaştırması​

Kapsamoctacity-org/.githubOctacity Docs
AmaçYönetişim, kurumsal politikalar, şablonlarPratik rehberlik, yöntemler, tecrübe aktarımı
NiteliğiBağlayıcı kural ve süreçlerÖneri, iyi pratikler, yol haritası
Örnek İçerikÜyelik şartları, liderlik yetkileri, CoC metniİyi PR nasıl açılır, fikri nasıl küçültürüm
DilResmi, standart ve bağlayıcıSamimi, doğrudan ve öğretici

Ne zaman hangisine bakmalıyım?​

  • .github deposuna bakın: Bir Octacity organizasyon kuralını, resmi katkı politikasını, ekip yapısını veya kurumsal şablonları öğrenmek istediğinizde.
  • Octacity Docs'a bakın: "Bu projeyi nasıl başlatmalıyım?", "Issue'yu nasıl yazarsam anlaşılır olur?", "Ekipte teknik anlaşmazlık çıkarsa ne yapmalıyız?" gibi geliştirme süreçlerine dair pratik cevaplar aradığınızda.

Neden kurallar dokümantasyona kopyalanmıyor?​

Politikaları ve resmi süreçleri dokümantasyon içine kopyalamak iki farklı bilgi kaynağının zamanla birbirinden kopmasına (drift) yol açar. Bir kural güncellendiğinde iki yerin birden güncellenmesi zorlaşır.

Bu nedenle Octacity Docs içerisinde resmi bir prosedür gerektiğinde doğrudan .github üzerindeki kanonik adrese link verilir.

Daha fazla bilgi​