Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
171 lines (112 loc) · 8.58 KB

CONTRIBUTING.md

File metadata and controls

171 lines (112 loc) · 8.58 KB
Raw

Zoo Code'a Katkıda Bulunma

Zoo Code topluluk tarafından yürütülen bir projedir ve her katkıyı derinden takdir ediyoruz. İşbirliğini kolaylaştırmak için Önce Sorun Yaklaşımı temelinde çalışıyoruz, bu da tüm Çekme İsteklerinin (PR'ler) önce bir GitHub Sorununa bağlanması gerektiği anlamına gelir. Lütfen bu kılavuzu dikkatlice inceleyin.

İçindekiler

Katkıda Bulunmadan Önce

1. Davranış Kuralları

Tüm katkıda bulunanlar Davranış Kurallarımıza uymalıdır.

2. Proje Yol Haritası

Yol haritamız projenin yönünü belirler. Katkılarınızı bu temel hedeflerle hizalayın:

Önce Güvenilirlik

  • Fark düzenleme ve komut yürütmenin tutarlı bir şekilde güvenilir olduğundan emin olun.
  • Düzenli kullanımı caydıran sürtünme noktalarını azaltın.
  • Tüm yerellerde ve platformlarda sorunsuz çalışmayı garanti edin.
  • Çok çeşitli yapay zeka sağlayıcıları ve modelleri için sağlam desteği genişletin.

Geliştirilmiş Kullanıcı Deneyimi

  • Netlik ve sezgisellik için kullanıcı arayüzünü/kullanıcı deneyimini kolaylaştırın.
  • Geliştiricilerin günlük kullanım araçlarından beklentilerini karşılamak için iş akışını sürekli iyileştirin.

Ajan Performansında Liderlik

  • Gerçek dünya verimliliğini ölçmek için kapsamlı değerlendirme ölçütleri (eval'ler) oluşturun.
  • Herkesin bu değerlendirmeleri kolayca çalıştırmasını ve yorumlamasını sağlayın.
  • Değerlendirme puanlarında net artışlar gösteren iyileştirmeler gönderin.

PR'lerinizde bu alanlarla uyumu belirtin.

3. Zoo Code topluluğuna katıl

  • Discord: Discord sunucumuza katıl.
  • Reddit: Reddit topluluğumuza katıl.

Katkınızı Bulma ve Planlama

Katkı Türleri

  • Hata Düzeltmeleri: kod sorunlarını giderme.
  • Yeni Özellikler: işlevsellik ekleme.
  • Belgelendirme: kılavuzları ve netliği iyileştirme.

Önce Sorun Yaklaşımı

Tüm katkılar, basit şablonlarımızı kullanarak bir GitHub Sorunu ile başlar.

  • Mevcut sorunları kontrol edin: GitHub Sorunlarında arama yapın.
  • Bir sorun oluşturun:
    • İyileştirmeler: "İyileştirme İsteği" şablonu (kullanıcı yararına odaklanan sade bir dil).
    • Hatalar: "Hata Raporu" şablonu (minimum yeniden oluşturma + beklenen vs gerçek + sürüm).
  • Üzerinde çalışmak ister misiniz? Soruna "Talep ediyorum" yorumu yapın ve atanmak için Discord üzerinden çekirdek ekiple iletişime geçin. Atama, başlıkta teyit edilecektir.
  • PR'ler soruna bağlanmalıdır. Bağlantısız PR'ler kapatılabilir.

Ne Üzerinde Çalışılacağına Karar Verme

Hataları Bildirme

  • Önce mevcut raporları kontrol edin.
  • Aşağıdakilerle "Hata Raporu" şablonunu kullanarak yeni bir hata oluşturun:
    • Açık, numaralandırılmış yeniden oluşturma adımları
    • Beklenen vs gerçek sonuç
    • Zoo Code sürümü (gerekli); ilgiliyse API sağlayıcısı/modeli
  • Güvenlik sorunları: Güvenlik tavsiyeleri aracılığıyla özel olarak bildirin.

Geliştirme ve Gönderme Süreci

Geliştirme Kurulumu

  1. Çatallayın ve Klonlayın:
git clone https://github.com/YOUR_USERNAME/Zoo-Code.git
  1. Bağımlılıkları Yükleyin:
pnpm install
  1. Hata Ayıklama: VS Code (F5) ile açın.

Kod Yazma Yönergeleri

  • Her özellik veya düzeltme için odaklanmış bir PR.
  • ESLint ve TypeScript en iyi uygulamalarını takip edin.
  • Sorunlara atıfta bulunan açık, açıklayıcı taahhütler yazın (ör. Düzeltmeler #123).
  • Kapsamlı testler sağlayın (npm test).
  • Göndermeden önce en son main dalına yeniden temel alın.

Bir Çekme İsteği Gönderme

  • Erken geri bildirim arıyorsanız Taslak PR olarak başlayın.
  • Çekme İsteği Şablonunu izleyerek değişikliklerinizi açıkça tanımlayın.
  • PR açıklamasında/başlığında sorunu bağlayın (ör. "Düzeltmeler #123").
  • Kullanıcı arayüzü değişiklikleri için ekran görüntüleri/videolar sağlayın.
  • Belge güncellemelerinin gerekli olup olmadığını belirtin.

Çekme İsteği Politikası

  • Atanmış bir GitHub Sorununa atıfta bulunmalıdır. Atanmak için: soruna "Talep ediyorum" yorumu yapın ve Discord üzerinden çekirdek ekiple iletişime geçin. Atama, başlıkta teyit edilecektir.
  • Bağlantısız PR'ler kapatılabilir.
  • PR'ler CI testlerini geçmeli, yol haritasıyla uyumlu olmalı ve net belgelere sahip olmalıdır.

İnceleme Süreci

  • Günlük Triyaj: Sürdürücüler tarafından hızlı kontroller.
  • Haftalık Derinlemesine İnceleme: Kapsamlı değerlendirme.
  • Geri bildirime göre hızlı bir şekilde yineleyin.

Pull Request Beklentileri

Pull Request'ler incelenebilir, test edilmiş ve sürdürülebilir olmalıdır. Bir PR açmadan önce şunları sağlayın:

  • Değişiklik belirli bir sorun, hata veya iyileştirmeyle sınırlıdır.
  • Değişikliğin ne yaptığını ve neden doğru olduğunu açıklayabilirsiniz.
  • Değişikliği mümkün olduğunda yerel olarak test ettiniz.
  • İnceleme geri bildirimine yanıt vermeye ve makul takip değişiklikleri yapmaya isteklisiniz.
  • PR, birleştirilmeden önce sürdürücülerin uygulamayı önemli ölçüde yeniden yazmasını, yeniden tasarlamasını veya sahiplenmesini gerektirmiyor.

Sürdürücüler, eksik, çok geniş kapsamlı, hareketsiz, proje yönüyle uyumsuz olan veya orantısız inceleme ya da bakım yükü oluşturan PR'leri kapatabilir. Bir PR'yi kapatmak, katkıda bulunan hakkında bir yargı değildir; değişikliğin mevcut biçimiyle kabul edilemeyeceğine dair bir sürdürücü kararıdır.

YZ Destekli Katkılar

YZ araçlarının kullanımına izin verilmektedir, ancak katkıda bulunanlar gönderimlerinden tamamen sorumlu kalmaya devam eder.

Bir PR oluşturmak için YZ araçları kullanıyorsanız şunları yapmanız gerekir:

  • Her önemli değişikliği gözden geçirin ve anlayın.
  • Uygulamayı ve değiş tokuşları kendi sözlerinizle açıklayabilin.
  • Değişikliği kendiniz test edin. Ortamınızda test yapmak pratik değilse, PR açıklamasında nedenini açıklayın ve gözlemcilerin değişikliği nasıl doğrulayabileceğini tarif edin.
  • Oluşturulan kodun doğru, gerekli ve proje lisansıyla uyumlu olduğunu doğrulayın.
  • YZ kodu, testleri veya tasarımı önemli ölçüde şekillendirdiyse PR açıklamasında YZ yardımını açıklamayı düşünün — bu, gözlemcilerin daha iyi geri bildirim vermesine yardımcı olur.

Anlamadığınız veya inceleme sürecinde sürdüremeyeceğiniz YZ tarafından oluşturulan değişiklikler göndermeyin. Sürdürücüler, büyük ölçüde YZ destekli görünen ancak insan doğrulaması, net gerekçe veya inceleme takibi olmayan PR'leri kapatabilir.

Yasal

Katkıda bulunarak, katkılarınızın Zoo Code'un lisanslamasıyla tutarlı olan Apache 2.0 Lisansı altında lisanslanacağını kabul etmiş olursunuz.