Katkı
Öneri süreci
Yeni bileşen, uyumu bozan değişiklik ya da kural değişikliği için öneri (RFC) ve karar kaydı (ADR) yazma, inceleme ve karar adımları.
Ne zaman öneri yazılır
Bölüm başlığı “Ne zaman öneri yazılır”| Değişiklik | Gereken |
|---|---|
| Yeni bileşen | Öneri (RFC) |
| Var olan bileşende uyumu bozan değişiklik (özellik kaldırma ya da adını değiştirme, davranış değişikliği) | Öneri (RFC) |
| Var olan eksende yeni varyant, en az iki ekranda kullanılan | Varyant kaydı: ilk kullanım, ekranlar, Figma bağlantısı, onaylayan (REUSE-03) |
| Yeni token ya da token adı değişikliği | Değişiklik kaydı; ad değişikliğinde geçiş notu |
| Mimari, paket sınırı, bağımlılık ya da kural değişikliği | Karar kaydı (ADR) |
| Hata düzeltmesi, doküman düzeltmesi | Gerekmez |
packages/ui/src altında önerisi olmayan yeni bir dosya incelemede reddedilir (REUSE-08).
Adımlar
Bölüm başlığı “Adımlar”- Arayın. Bileşenlere genel bakış sayfasında ve Storybook’ta benzer bir bileşen arayın. Kullandığınız arama kelimesini ve karar akışında hangi adımda kaldığınızı öneriye yazın (REUSE-06).
- Adı denetleyin. Önerilen ad var olan bir bileşenin kökünü tekrarlamamalı ve yasak eklerden birini taşımamalıdır; bkz. Adlandırma.
- Öneriyi yazın. Aşağıdaki şablonu doldurun. Önerilen arayüz, kodu yazacak kişinin başka bir soru sormadan başlayabileceği ayrıntıda olmalıdır.
- İnceleme. Öneri bir tasarımcı, bir geliştirici ve erişilebilirlik sorumlusu tarafından okunur. Sorular öneri üzerinde yanıtlanır.
- Karar. Öneri kabul, değişiklikle kabul ya da ret ile kapanır; gerekçe öneriye yazılır. Kabul edilmeden kod yazılmaz.
- Uygulama. Kabul edilen öneri Bileşen kontrol listesine göre tek bir değişiklikte uygulanır.
Öneri şablonu (RFC)
Bölüm başlığı “Öneri şablonu (RFC)”# RFC: <Bileşen adı>
- Durum: taslak | incelemede | kabul | ret- Yazan:- Tarih:
## SorunHangi kullanıcı hangi işi yaparken neye ihtiyaç duyuyor? Bugün nasıl çözülüyor?
## Kullanılacağı ekranlarEn az iki ekran, Figma bağlantılarıyla.
## Arama ve karar akışıKullanılan arama kelimeleri, incelenen bileşenler, karar akışında kalınan adım.
## Önerilen arayüzÖzellikler (ad, tür, varsayılan, açıklama), parçalar (`data-part`), durumlar ve varyantlar.
## Davranış ve hareketEtkileşim durumları, klavye, kullanılacak hareket önayarları, azaltılmış hareket davranışı.
## ErişilebilirlikRol, erişilebilir ad, klavye tablosu, odak yönetimi, ekran okuyucu çıktısı, ilgili WCAG 2.2 ölçütleri.
## Token'larKullanılacak anlam token'ları; gerekiyorsa yeni bileşen token'ları.
## MetinlerKütüphanenin kendi metinleri (`ui.*`), Türkçe ve İngilizce.
## Değerlendirilen alternatiflerEn az iki alternatif ve neden seçilmedikleri.Karar kaydı şablonu (ADR)
Bölüm başlığı “Karar kaydı şablonu (ADR)”Mimariyi, paket sınırlarını, bağımlılıkları ya da bir kuralı değiştiren her karar bir karar kaydına yazılır. Kayıtlar depoda docs/adr/ altında tutulur ve sonradan değiştirilmez; bir karar değişirse yeni bir kayıt eskisinin yerine geçer ve ona bağlantı verir.
# ADR 0000: <Karar başlığı>
- Durum: önerildi | kabul | yerine geçildi (ADR xxxx)- Tarih:
## BağlamKararı gerektiren durum ve kısıtlar.
## SeçeneklerEn az üç seçenek ve her biri için değerlendirme ölçütleri.
## KararSeçilen seçenek ve gerekçesi.
## SonuçlarKolaylaşan ve zorlaşan şeyler, geri dönüş yolu, takip edilecek işler.