Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
156 lines (115 loc) · 5.07 KB

CONTRIBUTING.md

File metadata and controls

156 lines (115 loc) · 5.07 KB

FinansApp Web'e Katkıda Bulunma

FinansApp Web'e katkıda bulunmayı düşündüğünüz için teşekkür ederiz! FinansApp'i harika bir araç yapan sizin gibi insanlardır.

Davranış Kuralları

Bu projeye katılarak, Davranış Kurallarımızı desteklemeyi kabul edersiniz:

  • Saygılı ve kapsayıcı olun
  • Konuşma ve eylemlerinizde düşünceli ve saygılı olun
  • Çatışmadan önce işbirliği yapmaya çalışın
  • Çevrenizin ve diğer katılımcıların farkında olun

Nasıl Katkıda Bulunabilirsiniz?

Hata Bildirimi

Hata raporu oluşturmadan önce, lütfen issue listesini kontrol edin, çünkü yeni bir tane oluşturmanıza gerek olmadığını görebilirsiniz. Bir hata raporu oluştururken, lütfen mümkün olduğunca fazla ayrıntı ekleyin:

  • Issue için net ve açıklayıcı bir başlık kullanın
  • Sorunu yeniden oluşturmak için tam adımları açıklayın
  • Adımları göstermek için spesifik örnekler verin
  • Adımları takip ettikten sonra gözlemlediğiniz davranışı açıklayın
  • Bunun yerine hangi davranışı görmeyi beklediğinizi ve nedenini açıklayın
  • Mümkünse ekran görüntüleri ve animasyonlu GIF'ler ekleyin
  • Ortam detaylarınızı ekleyin (İşletim sistemi, tarayıcı, Node sürümü vb.)

Geliştirme Önerileri

Geliştirme önerileri GitHub issues olarak takip edilir. Bir geliştirme önerisi oluştururken, lütfen şunları ekleyin:

  • Net ve açıklayıcı bir başlık kullanın
  • Önerilen geliştirmenin detaylı bir açıklamasını sağlayın
  • Adımları göstermek için spesifik örnekler sağlayın veya uygulanabilirse mock-up'lar sağlayın
  • Mevcut davranışı açıklayın ve bunun yerine hangi davranışı görmeyi beklediğinizi açıklayın
  • Bu geliştirmenin neden faydalı olacağını açıklayın

Pull Request'ler

  1. Repo'yu fork edin ve main'den branch'inizi oluşturun
  2. Test edilmesi gereken kod eklediyseniz, testler ekleyin
  3. API'leri değiştirdiyseniz, dokümantasyonu güncelleyin
  4. Test suite'inin geçtiğinden emin olun
  5. Kodunuzun lint kontrolünden geçtiğinden emin olun
  6. Pull request'i gönderin!

Geliştirme Süreci

Geliştirme Ortamını Kurma

  1. Repository'yi fork edin ve klonlayın
git clone https://github.com/KULLANICI_ADINIZ/finansapp-web.git
cd finansapp-web
  1. Bağımlılıkları yükleyin
npm install

  1. .env.example dosyasına göre .env dosyası oluşturun

  2. Geliştirme sunucusunu başlatın

npm run dev

Kodlama Stili

  • Tip güvenliği için TypeScript kullanın
  • Mevcut kod stilini takip edin (ESLint yapılandırması)
  • Anlamlı commit mesajları yazın
  • Fonksiyonları küçük ve odaklı tutun
  • Karmaşık mantık için yorumlar ekleyin
  • Açıklayıcı değişken ve fonksiyon isimleri kullanın

Commit Mesajları

Conventional Commits spesifikasyonunu takip ediyoruz:

feat: yeni özellik ekle
fix: hata düzelt
docs: dokümantasyonu güncelle
style: kodu formatla
refactor: kodu yeniden düzenle
test: test ekle
chore: bağımlılıkları güncelle

Örnekler:

feat: işlemler sayfasına kategori filtresi ekle
fix: Türkçe karakterlerle PDF ayrıştırma sorununu çöz
docs: Gemini API talimatlarıyla kurulum kılavuzunu güncelle

Branch İsimlendirme

Açıklayıcı branch isimleri kullanın:

  • feature/aciklama - yeni özellikler için
  • fix/aciklama - hata düzeltmeleri için
  • docs/aciklama - dokümantasyon güncellemeleri için
  • refactor/aciklama - kod yeniden düzenlemeleri için

Örnekler:

  • feature/karanlik-mod
  • fix/pdf-yukleme-hatasi
  • docs/api-kurulum-kilavuzu

Test

Pull request göndermeden önce:

  1. Değişikliklerinizi kapsamlı bir şekilde test edin
  2. Lint kontrolü çalıştırın: npm run lint
  3. Projeyi build edin: npm run build
  4. UI değişiklikleri söz konusuysa birden fazla tarayıcıda test edin

Proje Yapısı

src/
├── components/     # Yeniden kullanılabilir React bileşenleri
├── pages/         # Sayfa bileşenleri
├── lib/           # Yardımcı araçlar ve servisler
├── contexts/      # React contexts
├── types/         # TypeScript tip tanımlamaları
└── hooks/         # Custom React hooks

Kullanılan Teknolojiler

  • Frontend: React 19, TypeScript, Tailwind CSS
  • Build Aracı: Vite
  • Backend: Supabase (PostgreSQL, Auth, Storage)
  • AI: OpenAI GPT-4, Google Gemini
  • UI Bileşenleri: shadcn/ui, Radix UI
  • Grafikler: Recharts
  • Form İşleme: React Hook Form + Zod

Yardım Alma

  • Kurulum talimatları için README.md dosyasını kontrol edin
  • Detaylı yapılandırma için SETUP_GUIDE.md dosyasını kontrol edin
  • Hatalar veya sorular için issue açın
  • Mevcut issue'ları ve pull request'leri inceleyin

Tanınma

Katkıda bulunanlar README'mizde ve sürüm notlarında tanınacaktır. Katkılarınız için teşekkür ederiz!

Katkıda bulunarak, katkılarınızın MIT Lisansı altında lisanslanacağını kabul etmiş olursunuz.