For the complete documentation index, see llms.txt. This page is also available as Markdown.

Katkıda Bulunma

PancakeSwap'a katkıda bulunmak için başvurduğunuz için teşekkürler!

PancakeSwap açık kaynaklı bir projedir. Projeye katkıda bulunmak istiyorsan bu bölüm, PancakeSwap ekibiyle ilk adımlarında sana rehberlik etmek için burada 🥞

Herhangi bir geliştirmeye başlamadan önce, sorunu ve çözümü ekiple tartışmak için Github'da bir issue açmanı şiddetle tavsiye ederiz.

Geliştirme ortamını kur

yarn yüklü değilse yükle.

  1. Repoyu fork'la ve klonla

  2. upstream remote'unu ekle. Örneğin:

  3. Varsayılan branch'in ( develop ) en güncel sürümünde olduğundan emin ol

  4. Kendi branch'ini oluştur ve bağımlılıkları yükle

  5. Keyifli kodlamalar 🎉

Kodlama kuralları

Repolarımız arasında mümkün olduğunca tutarlılığı korumaya çalışıyoruz. Aşağıdaki kurallara uyarsan ve yüksek kaliteli kod yazarsan pull request'inin kabul edilme şansı artar. Başlayalım 💪

UIKit'i Kullan

Bir bileşenin varyantının oluşturulması gerekiyorsa, ilgili bileşeni UI Kit'ten temel olarak kullan. Örneğin:

Araçları Kullan!

Repolarımızın çoğu Typescript, ESLint ve Prettier kullanır. Typescript'in en iyi uygulamalarına hakim olduğundan emin ol ve IDE'n için bir ESLint ve Prettier eklentisi etkinleştir.

İyi uygulamalar

  • Bileşenleri mümkün olduğunca küçük ve "dumb" tut.

  • Kodunun birden fazla geliştirici tarafından okunacağını ve bakımının yapılacağını aklında tut. Mümkün olduğunca anlaşılır ve güncellemesi kolay yaz.

Pull request oluştur

Kodun inceleme için hazır, tebrikler🥳

  • Tüm pull request'lerin PR'ın ne yapmaya çalıştığına dair bir açıklama içermesi zorunludur.

  • Pull request'leri mümkün olduğunca küçük tut. Daha büyük pull request'ler, özel bir temel branch ile daha küçük parçalara bölünmelidir. Temel branch'ine birleşecek PR'ları epic etiketiyle işaretle.

  • Mümkünse PR'ını kendi kendine incele ve ek açıklama gereken yerlere yorumlar ekle.

İlerlememizi izleyebilmemiz için en kısa sürede taslak PR oluştur.

Pull Request Başlığı

Pull Request Başlıklarımız commitlint kullanan Conventional Commits standardını takip eder.‌

Daha fazlası için Angular'ın yönergeleri

Tür
Açıklama

build

Derleme sistemini veya harici bağımlılıkları etkileyen değişiklikler (örnek kapsamlar: gulp, broccoli, npm)

ci

CI yapılandırma dosyaları ve script'lerindeki değişiklikler (örnek kapsamlar: Travis, Circle, BrowserStack, SauceLabs)

docs

Yalnızca dokümantasyon değişiklikleri

feat

Yeni bir özellik

fix

Hata düzeltmesi

perf

Performansı iyileştiren kod değişikliği

refactor

Ne hata düzelten ne de özellik ekleyen kod değişikliği

style

Kodun anlamını etkilemeyen değişiklikler (boşluk, biçimlendirme, eksik noktalı virgüller vb.)

test

Eksik testlerin eklenmesi veya mevcut testlerin düzeltilmesi

PancakeSwap'ı daha da harika yapmanamıza yardımcı olduğun için teşekkürler

Last updated

Was this helpful?