zynpdata-zynp_ai-teknofest / CONTRIBUTING.md
sekerlipencere's picture
Create CONTRIBUTING.md
33f8cbd verified
# Katkıda Bulunma Rehberi
Ö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.
## Nasıl Katkıda Bulunabilirsiniz?
1. **Hata Bildirimi:**
- 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.
- Hata bildiriminde açık ve anlaşılır bir açıklama sağlayın.
- Hata ile ilgili ekran görüntüleri veya hata mesajlarını ekleyin.
2. **Özellik İsteği:**
- 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.
- Özelliğin nasıl çalışması gerektiğini ve neden gerekli olduğunu detaylandırın.
3. **Kod Katkıları:**
- Depoyu çatallayın (`Fork`).
- Yeni bir dal (`branch`) oluşturun: `git checkout -b feature-ismi`
- Yaptığınız değişiklikleri commit edin: `git commit -m 'Özellik açıklaması'`
- Dalı depoya gönderin (`Push`): `git push origin feature-ismi`
- Bir `Pull Request` oluşturun.
## Kodlama Standartları
- **Kod Temizliği:** Kodlarınızı okunabilir ve anlaşılır yazmaya özen gösterin. Gereksiz karmaşıklıklardan kaçının.
- **Yorumlar:** Karmaşık kod blokları için açıklayıcı yorumlar ekleyin.
- **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.
## Katkıda Bulunmadan Önce
- Projenin [README.md](README.md) dosyasını okuyarak proje yapısı ve katkı kuralları hakkında bilgi sahibi olun.
- Geliştirme ortamınızı proje gereksinimlerine uygun şekilde ayarlayın.
- 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.
## Katkı Süreci
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.
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.
3. Katkınız uygun görülürse projeye dahil edilecektir.
## İletişim
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.
Bu projeyi daha iyi hale getirmek için yardımlarınızı ve işbirliğinizi dört gözle bekliyoruz!