Create CONTRIBUTING.md
Browse files- CONTRIBUTING.md +45 -0
CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Katkıda Bulunma Rehberi
|
| 2 |
+
|
| 3 |
+
Öncelikle, bu projeye katkıda bulunmayı düşündüğünüz için teşekkür ederiz! Açık kaynak projeler, katılımcılar sayesinde gelişir ve büyür. Bu nedenle, katkılarınızı çok değerli buluyoruz.
|
| 4 |
+
|
| 5 |
+
## Nasıl Katkıda Bulunabilirsiniz?
|
| 6 |
+
|
| 7 |
+
1. **Hata Bildirimi:**
|
| 8 |
+
- Bir hata fark ederseniz, lütfen [GitHub Issues](https://github.com/sekerlipencere/zynpdata-zynp_ai-teknofest/issues) sayfasına giderek bir hata bildirimi oluşturun.
|
| 9 |
+
- Hata bildiriminde açık ve anlaşılır bir açıklama sağlayın.
|
| 10 |
+
- Hata ile ilgili ekran görüntüleri veya hata mesajlarını ekleyin.
|
| 11 |
+
|
| 12 |
+
2. **Özellik İsteği:**
|
| 13 |
+
- Yeni bir özellik eklemek istiyorsanız, [GitHub Issues](https://github.com/sekerlipencere/zynpdata-zynp_ai-teknofest/issues) sayfasında bir özellik isteği oluşturun.
|
| 14 |
+
- Özelliğin nasıl çalışması gerektiğini ve neden gerekli olduğunu detaylandırın.
|
| 15 |
+
|
| 16 |
+
3. **Kod Katkıları:**
|
| 17 |
+
- Depoyu çatallayın (`Fork`).
|
| 18 |
+
- Yeni bir dal (`branch`) oluşturun: `git checkout -b feature-ismi`
|
| 19 |
+
- Yaptığınız değişiklikleri commit edin: `git commit -m 'Özellik açıklaması'`
|
| 20 |
+
- Dalı depoya gönderin (`Push`): `git push origin feature-ismi`
|
| 21 |
+
- Bir `Pull Request` oluşturun.
|
| 22 |
+
|
| 23 |
+
## Kodlama Standartları
|
| 24 |
+
|
| 25 |
+
- **Kod Temizliği:** Kodlarınızı okunabilir ve anlaşılır yazmaya özen gösterin. Gereksiz karmaşıklıklardan kaçının.
|
| 26 |
+
- **Yorumlar:** Karmaşık kod blokları için açıklayıcı yorumlar ekleyin.
|
| 27 |
+
- **Değişiklik Takibi:** Her bir değişiklik, mantıksal bir bütünlüğe sahip olmalıdır. Birden fazla konuya dokunan değişiklikler için ayrı ayrı commitler yapın.
|
| 28 |
+
|
| 29 |
+
## Katkıda Bulunmadan Önce
|
| 30 |
+
|
| 31 |
+
- Projenin [README.md](README.md) dosyasını okuyarak proje yapısı ve katkı kuralları hakkında bilgi sahibi olun.
|
| 32 |
+
- Geliştirme ortamınızı proje gereksinimlerine uygun şekilde ayarlayın.
|
| 33 |
+
- Başkalarının da üzerinde çalışabileceği kodlar geliştirdiğinizi unutmayın. Bu nedenle, kodunuzun başkaları tarafından anlaşılabilir ve sürdürülebilir olmasına dikkat edin.
|
| 34 |
+
|
| 35 |
+
## Katkı Süreci
|
| 36 |
+
|
| 37 |
+
1. Bir hata veya yeni bir özellik isteği oluşturduğunuzda veya bir `Pull Request` gönderdiğinizde, katkınız gözden geçirilecektir.
|
| 38 |
+
2. Gözden geçirme aşamasında, sizden bazı değişiklikler veya açıklamalar istenebilir. Lütfen bu geri bildirimlere uygun şekilde yanıt verin.
|
| 39 |
+
3. Katkınız uygun görülürse projeye dahil edilecektir.
|
| 40 |
+
|
| 41 |
+
## İletişim
|
| 42 |
+
|
| 43 |
+
Herhangi bir sorunuz veya öneriniz varsa, lütfen [GitHub Issues](https://github.com/sekerlipencere/zynpdata-zynp_ai-teknofest/issues) bölümünde bizimle iletişime geçin.
|
| 44 |
+
|
| 45 |
+
Bu projeyi daha iyi hale getirmek için yardımlarınızı ve işbirliğinizi dört gözle bekliyoruz!
|