Hatcher'a Katkıda Bulunma
Hatcher'a katkıda bulunma ilginiz için teşekkürler! Bu rehber projeye katkıda bulunmaya başlamanızda yardımcı olacaktır.
Davranış Kuralları
Bu projeye katılarak, Davranış Kurallarımızı kabul etmiş olursunuz. Katkıda bulunmadan önce lütfen okuyun.
Başlarken
Geliştirme Kurulumu
Fork ve Clone
bashgit clone https://github.com/your-username/dx-engine.git cd dx-engine
Bağımlılıkları Yükle
bashpnpm install
Geliştirme Sunucusunu Başlat
bashpnpm dev
Proje Yapısı
dx-engine/
├── apps/
│ ├── electron/ # Ana Electron süreci
│ ├── web/ # Renderer süreci (Vue.js)
│ ├── preload/ # Preload scriptleri
│ └── docs/ # VitePress dokümantasyonu
├── universal/
│ ├── vite-plugin/ # Özel Vite eklentileri
│ └── puppeteer-google-translate/
└── scripts/ # Build ve geliştirme scriptleri
Katkıda Bulunma Yolları
Bug Bildirme
Bug bildirirken lütfen şunları ekleyin:
- Açık Açıklama: Ne oldu vs. ne beklediğiniz
- Yeniden Üretme Adımları: Sorunu yeniden oluşturmak için detaylı adımlar
- Ortam: İşletim sistemi, Node.js sürümü, pnpm sürümü
- Ekran Görüntüleri: Uygunsa, görsel kanıt ekleyin
Issue oluştururken bug raporu şablonumuzu kullanın.
Özellik İstekleri
Özellik isteklerini memnuniyetle karşılıyoruz! Lütfen şunları ekleyin:
- Kullanım Durumu: Bu özellik neden gerekli?
- Önerilen Çözüm: Nasıl çalışmalı?
- Alternatifler: Hangi diğer yaklaşımları düşündünüz?
Özellik isteği şablonumuzu kullanın.
Kod Katkıları
Başlamadan Önce
- Mevcut Issue'ları Kontrol Edin: İlgili issue'ları veya özellik isteklerini arayın
- Büyük Değişiklikleri Tartışın: Önemli değişiklikleri tartışmak için bir issue açın
- Küçük Başlayın: Küçük, odaklanmış katkılarla başlayın
Geliştirme İş Akışı
Branch Oluştur
bashgit checkout -b feature/your-feature-name
Değişiklik Yap
- Kodlama standartlarımızı takip edin (aşağıya bakın)
- Yeni işlevsellik için testler yazın
- Gerektiğinde dokümantasyonu güncelleyin
Değişikliklerinizi Test Edin
bashpnpm build pnpm test
Değişikliklerinizi Commit Edin
bashgit commit -m "feat: add amazing new feature"
Conventional Commits formatını takip ediyoruz.
Push ve PR Oluştur
bashgit push origin feature/your-feature-name
Kodlama Standartları
Hatcher, projenin tamamında tutarlılık, sürdürülebilirlik ve yüksek kaliteli kod sağlamak için katı kodlama standartlarını takip eder.
📋 Tam Kodlama Standartları Rehberi
Hızlı Referans
TypeScript
- Tüm yeni kod için strict mode etkin TypeScript kullanın
- Nesne şekilleri için type'lar yerine interface'leri tercih edin
- Değişkenler ve fonksiyonlar için anlamlı, açıklayıcı isimler kullanın
- Tüm genel API'ler için JSDoc yorumları ekleyin
Vue.js
<script setup>
sözdizimi ile Composition API kullanın- Props ve emits'i TypeScript interface'leri ile tanımlayın
- Yeniden kullanılabilir mantık için composable'ları tercih edin
- Tek dosya bileşen yapısını takip edin: script → template → style
Kod Kalite Araçları
Standartları uygulamak için otomatik araçlar kullanıyoruz:
# Kod stili sorunlarını lint et ve düzelt
pnpm lint:fix
# Tip kontrolü
pnpm typecheck
# Tüm testleri çalıştır
pnpm test
# Kodu formatla
pnpm format
Pull Request Süreci
Göndermeden Önce
- [ ] Kod proje standartlarını takip ediyor
- [ ] Testler yerel olarak geçiyor
- [ ] Dokümantasyon güncellendi
- [ ] Değişiklikler odaklanmış ve atomik
PR Açıklama Şablonu
## Açıklama
Değişikliklerin kısa açıklaması
## Değişiklik Türü
- [ ] Bug düzeltmesi
- [ ] Yeni özellik
- [ ] Kırıcı değişiklik
- [ ] Dokümantasyon güncellemesi
## Test
- [ ] Birim testleri eklendi/güncellendi
- [ ] Entegrasyon testleri eklendi/güncellendi
- [ ] Manuel test tamamlandı
Topluluk
İletişim Kanalları
- GitHub Issues: Bug raporları ve özellik istekleri
- GitHub Discussions: Genel sorular ve fikirler
- Discord: Toplulukla gerçek zamanlı sohbet
- Twitter: Güncellemeler için @HatcherDX'i takip edin
Topluluk Kuralları
- Saygılı Olun: Herkese saygıyla davranın
- Yapıcı Olun: Problemlere değil çözümlere odaklanın
- Sabırlı Olun: Hepimizin gönüllü olduğunu unutmayın
- Yardımcı Olun: Bilgiyi paylaşın ve diğerlerine yardım edin
Geliştirme Kaynakları
Faydalı Bağlantılar
Sorular?
Katkıda bulunma hakkında sorularınız varsa:
- Mevcut GitHub Discussions'ı kontrol edin
- Discord topluluğumuza katılın
- Yeni bir tartışma veya issue oluşturun
Hatcher'a katkıda bulunduğunuz için teşekkürler! Birlikte, AI destekli geliştirmenin geleceğini inşa ediyoruz.