Add CONTRIBUTING.md
Browse files- CONTRIBUTING.md +59 -0
CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Katkıda Bulunma Rehberi
|
| 2 |
+
|
| 3 |
+
Bu projeye katkıda bulunmak istediğiniz için teşekkürler! Lütfen aşağıdaki adımları izleyiniz.
|
| 4 |
+
|
| 5 |
+
## Başlamadan Önce
|
| 6 |
+
|
| 7 |
+
1. **Projeyi Fork Edin**: GitHub üzerinde bu projenin bir kopyasını kendi hesabınıza alınız.
|
| 8 |
+
2. **Klonlayın**: Forkladığınız projeyi yerel bilgisayarınıza klonlayınız:
|
| 9 |
+
```bash
|
| 10 |
+
git clone https://github.com/KULLANICI_ADI/OmegaCode.git
|
| 11 |
+
cd OmegaCode
|
| 12 |
+
```
|
| 13 |
+
3. **Yeni Bir Branch Oluşturun**: Özellik veya hata düzeltmesi için yeni bir branch oluşturunuz:
|
| 14 |
+
```bash
|
| 15 |
+
git checkout -b feature/ozellik-adi
|
| 16 |
+
```
|
| 17 |
+
|
| 18 |
+
## Kod Yazma Kuralları
|
| 19 |
+
|
| 20 |
+
* **Python Stili**: PEP 8 standardını takip ediniz.
|
| 21 |
+
* **Docstring**: Her fonksiyon ve sınıf için açıklayıcı docstring yazınız.
|
| 22 |
+
* **Testler**: Yeni özellikler için test kodları yazınız.
|
| 23 |
+
* **Yorumlar**: Karmaşık mantığı açıklayan yorumlar ekleyiniz.
|
| 24 |
+
|
| 25 |
+
## Değişiklikleri Göndermek
|
| 26 |
+
|
| 27 |
+
1. **Değişiklikleri Commit Edin**:
|
| 28 |
+
```bash
|
| 29 |
+
git add .
|
| 30 |
+
git commit -m "Açıklayıcı bir commit mesajı yazınız"
|
| 31 |
+
```
|
| 32 |
+
|
| 33 |
+
2. **Push Yapınız**:
|
| 34 |
+
```bash
|
| 35 |
+
git push origin feature/ozellik-adi
|
| 36 |
+
```
|
| 37 |
+
|
| 38 |
+
3. **Pull Request Açınız**: GitHub üzerinde orijinal projeye karşı bir Pull Request açınız. Açıklamada neler yaptığınızı detaylı bir şekilde belirtiniz.
|
| 39 |
+
|
| 40 |
+
## Hata Bildirme
|
| 41 |
+
|
| 42 |
+
Bir hata bulduysanız, lütfen GitHub Issues sekmesinden yeni bir issue açınız. Şunları belirtiniz:
|
| 43 |
+
|
| 44 |
+
* Hatanın açıklaması
|
| 45 |
+
* Hatayı tekrar üretme adımları
|
| 46 |
+
* Beklenen ve gerçek davranış
|
| 47 |
+
* Kullandığınız Python ve PyTorch versiyonları
|
| 48 |
+
|
| 49 |
+
## Sorular ve Tartışmalar
|
| 50 |
+
|
| 51 |
+
Sorularınız veya önerileriniz için GitHub Discussions sekmesini kullanınız.
|
| 52 |
+
|
| 53 |
+
## Davranış Kuralları
|
| 54 |
+
|
| 55 |
+
* Saygılı ve yapıcı bir ortam yaratınız.
|
| 56 |
+
* Farklı görüşleri saygıyla karşılayınız.
|
| 57 |
+
* Hakaret veya ayrımcı dil kullanmayınız.
|
| 58 |
+
|
| 59 |
+
Teşekkürler! 🙏
|