11 KiB
Veri Bilimine Giriş için Katkıda Bulunma
Veri Bilimine Giriş müfredatına katkıda bulunma ilginiz için teşekkür ederiz! Topluluktan gelen katkıları memnuniyetle karşılıyoruz.
İçindekiler
- Davranış Kuralları
- Nasıl Katkıda Bulunabilirim?
- Başlarken
- Katkı Kuralları
- Pull Request Süreci
- Stil Kuralları
- Katkıda Bulunma Lisans Anlaşması
Davranış Kuralları
Bu proje Microsoft Açık Kaynak Davranış Kuralları benimsemiştir. Daha fazla bilgi için Davranış Kuralları SSS bölümüne bakabilir veya ek sorularınız ya da yorumlarınız için opencode@microsoft.com adresine e-posta gönderebilirsiniz.
Nasıl Katkıda Bulunabilirim?
Hata Bildirme
Hata raporları oluşturmadan önce, mevcut sorunları kontrol ederek yinelenen raporları önleyin. Hata raporu oluştururken mümkün olduğunca fazla ayrıntı ekleyin:
- Açık ve açıklayıcı bir başlık kullanın
- Sorunu yeniden oluşturmak için gereken adımları ayrıntılı olarak açıklayın
- Spesifik örnekler sağlayın (kod parçacıkları, ekran görüntüleri)
- Gözlemlediğiniz davranışı ve beklediğiniz sonucu açıklayın
- Ortam detaylarınızı ekleyin (işletim sistemi, Python sürümü, tarayıcı)
İyileştirme Önerileri
İyileştirme önerileri memnuniyetle karşılanır! Öneri yaparken:
- Açık ve açıklayıcı bir başlık kullanın
- Önerilen iyileştirmeyi ayrıntılı olarak açıklayın
- Bu iyileştirmenin neden faydalı olacağını açıklayın
- Diğer projelerdeki benzer özellikleri listeleyin (varsa)
Dokümantasyona Katkıda Bulunma
Dokümantasyon iyileştirmeleri her zaman takdir edilir:
- Yazım hatalarını ve dilbilgisi hatalarını düzeltin
- Açıklamaların netliğini artırın
- Eksik dokümantasyonu ekleyin
- Güncel olmayan bilgileri güncelleyin
- Örnekler veya kullanım durumları ekleyin
Kod Katkıları
Kod katkıları memnuniyetle karşılanır, örneğin:
- Yeni dersler veya alıştırmalar
- Hata düzeltmeleri
- Mevcut not defterlerinde iyileştirmeler
- Yeni veri setleri veya örnekler
- Quiz uygulaması iyileştirmeleri
Başlarken
Ön Koşullar
Katkıda bulunmadan önce aşağıdakilere sahip olduğunuzdan emin olun:
- Bir GitHub hesabı
- Sisteminizde yüklü Git
- Python 3.7+ ve Jupyter yüklü
- Node.js ve npm (quiz uygulaması katkıları için)
- Müfredat yapısına aşinalık
Ayrıntılı kurulum talimatları için INSTALLATION.md dosyasına bakın.
Fork ve Klonlama
- GitHub'da deponun fork'unu oluşturun
- Fork'unuzu yerel olarak klonlayın:
git clone https://github.com/YOUR-USERNAME/Data-Science-For-Beginners.git cd Data-Science-For-Beginners - Upstream remote ekleyin:
git remote add upstream https://github.com/microsoft/Data-Science-For-Beginners.git
Bir Dal Oluşturun
Çalışmanız için yeni bir dal oluşturun:
git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix
Dal adlandırma kuralları:
feature/- Yeni özellikler veya derslerfix/- Hata düzeltmeleridocs/- Dokümantasyon değişikliklerirefactor/- Kod yeniden düzenleme
Katkı Kuralları
Ders İçeriği İçin
Yeni dersler eklerken veya mevcut olanları değiştirirken:
-
Mevcut yapıyı takip edin:
- README.md ile ders içeriği
- Alıştırmalar içeren Jupyter not defteri
- Ödev (varsa)
- Ön ve son quiz bağlantıları
-
Şu öğeleri ekleyin:
- Açık öğrenme hedefleri
- Adım adım açıklamalar
- Yorumlarla birlikte kod örnekleri
- Pratik için alıştırmalar
- Ek kaynaklara bağlantılar
-
Erişilebilirliği sağlayın:
- Açık, basit bir dil kullanın
- Görseller için alt metin sağlayın
- Kod yorumları ekleyin
- Farklı öğrenme stillerini göz önünde bulundurun
Jupyter Not Defterleri İçin
-
Tüm çıktıları temizleyin:
jupyter nbconvert --clear-output --inplace notebook.ipynb -
Açıklamalar içeren markdown hücreleri ekleyin
-
Tutarlı biçimlendirme kullanın:
# Import libraries at the top import pandas as pd import numpy as np import matplotlib.pyplot as plt # Use meaningful variable names # Add comments for complex operations # Follow PEP 8 style guidelines -
Not defterinizi tamamen test edin ve ardından gönderin
Python Kodu İçin
PEP 8 stil kurallarını takip edin:
# Good practices
import pandas as pd
def calculate_mean(data):
"""Calculate the mean of a dataset.
Args:
data (list): List of numerical values
Returns:
float: Mean of the dataset
"""
return sum(data) / len(data)
Quiz Uygulaması Katkıları İçin
Quiz uygulamasını değiştirirken:
-
Yerel olarak test edin:
cd quiz-app npm install npm run serve -
Linter çalıştırın:
npm run lint -
Başarıyla derleyin:
npm run build -
Vue.js stil rehberini ve mevcut desenleri takip edin
Çeviriler İçin
Çeviriler eklerken veya güncellerken:
translations/klasöründeki yapıyı takip edin- Dil kodunu klasör adı olarak kullanın (ör. Fransızca için
fr) - İngilizce sürümle aynı dosya yapısını koruyun
- Quiz bağlantılarını dil parametresiyle güncelleyin:
?loc=fr - Tüm bağlantıları ve biçimlendirmeyi test edin
Pull Request Süreci
Göndermeden Önce
-
Dalınızı en son değişikliklerle güncelleyin:
git fetch upstream git rebase upstream/main -
Değişikliklerinizi test edin:
- Değiştirilen tüm not defterlerini çalıştırın
- Quiz uygulamasını test edin (değiştirildiyse)
- Tüm bağlantıların çalıştığını doğrulayın
- Yazım ve dilbilgisi hatalarını kontrol edin
-
Değişikliklerinizi commit edin:
git add . git commit -m "Brief description of changes"Açık commit mesajları yazın:
- Şimdiki zaman kullanın ("Özellik ekle" değil "Özellik eklendi")
- Emir kipinde yazın ("İmleci taşı..." değil "İmleç taşınıyor...")
- İlk satırı 72 karakterle sınırlayın
- İlgili sorunları ve pull request'leri referans gösterin
-
Fork'unuza push yapın:
git push origin feature/your-feature-name
Pull Request Oluşturma
- Depoya gidin
- "Pull requests" → "New pull request" seçeneğine tıklayın
- "compare across forks" seçeneğine tıklayın
- Fork ve dalınızı seçin
- "Create pull request" seçeneğine tıklayın
PR Başlık Formatı
Açık, açıklayıcı başlıklar kullanın ve şu formatı takip edin:
[Component] Brief description
Örnekler:
[Ders 7] Python not defteri import hatasını düzelt[Quiz Uygulaması] Almanca çeviri ekle[Dokümanlar] README'yi yeni ön koşullarla güncelle[Düzeltme] Görselleştirme dersindeki veri yolunu düzelt
PR Açıklaması
PR açıklamanıza şunları ekleyin:
- Ne: Hangi değişiklikleri yaptınız?
- Neden: Bu değişiklikler neden gerekli?
- Nasıl: Değişiklikleri nasıl uyguladınız?
- Test: Değişiklikleri nasıl test ettiniz?
- Ekran Görüntüleri: Görsel değişiklikler için ekran görüntüleri ekleyin
- İlgili Sorunlar: İlgili sorunlara bağlantı verin (ör. "Fixes #123")
İnceleme Süreci
- Otomatik kontroller PR'nizde çalıştırılacak
- Bakıcılar katkınızı inceleyecek
- Geri bildirimi ele alın ve ek commit'ler yapın
- Onaylandıktan sonra, bir bakıcı PR'nizi birleştirecek
PR'niz Birleştirildikten Sonra
-
Dalınızı silin:
git branch -d feature/your-feature-name git push origin --delete feature/your-feature-name -
Fork'unuzu güncelleyin:
git checkout main git pull upstream main git push origin main
Stil Kuralları
Markdown
- Tutarlı başlık seviyeleri kullanın
- Bölümler arasında boş satırlar ekleyin
- Dil belirticileriyle kod blokları kullanın:
```python import pandas as pd ``` - Görseller için alt metin ekleyin:
 - Satır uzunluklarını makul tutun (yaklaşık 80-100 karakter)
Python
- PEP 8 stil rehberini takip edin
- Anlamlı değişken adları kullanın
- Fonksiyonlara docstring ekleyin
- Uygun yerlerde tür ipuçları ekleyin:
def process_data(df: pd.DataFrame) -> pd.DataFrame: """Process the input dataframe.""" return df
JavaScript/Vue.js
- Vue.js 2 stil rehberini takip edin
- Sağlanan ESLint yapılandırmasını kullanın
- Modüler, yeniden kullanılabilir bileşenler yazın
- Karmaşık mantık için yorumlar ekleyin
Dosya Organizasyonu
- İlgili dosyaları bir arada tutun
- Açıklayıcı dosya adları kullanın
- Mevcut dizin yapısını takip edin
- Gereksiz dosyaları commit etmeyin (.DS_Store, .pyc, node_modules, vb.)
Katkıda Bulunma Lisans Anlaşması
Bu proje katkıları ve önerileri memnuniyetle karşılar. Çoğu katkı, bize katkınızı kullanma hakkını verdiğinizi ve bu hakkı gerçekten verdiğinizi beyan eden bir Katkıda Bulunma Lisans Anlaşması (CLA) kabul etmenizi gerektirir. Ayrıntılar için https://cla.microsoft.com adresini ziyaret edin.
Bir pull request gönderdiğinizde, bir CLA-bot otomatik olarak bir CLA sağlayıp sağlamanız gerekip gerekmediğini belirleyecek ve PR'yi uygun şekilde işaretleyecektir (ör. etiket, yorum). Bot tarafından sağlanan talimatları takip etmeniz yeterlidir. Bu işlemi, CLA kullanan tüm depolar için yalnızca bir kez yapmanız gerekecek.
Sorular?
- Discord Kanalımız #data-science-for-beginners adresine göz atın
- Discord topluluğumuza katılın
- Mevcut sorunları ve pull request'leri inceleyin
Teşekkürler!
Katkılarınız bu müfredatı herkes için daha iyi hale getiriyor. Katkıda bulunmak için zaman ayırdığınız için teşekkür ederiz!
Feragatname:
Bu belge, AI çeviri hizmeti Co-op Translator kullanılarak çevrilmiştir. Doğruluk için çaba göstersek de, otomatik çevirilerin hata veya yanlışlık içerebileceğini lütfen unutmayın. Belgenin orijinal dili, yetkili kaynak olarak kabul edilmelidir. Kritik bilgiler için profesyonel insan çevirisi önerilir. Bu çevirinin kullanımından kaynaklanan yanlış anlamalar veya yanlış yorumlamalar için sorumluluk kabul edilmez.