Katkı
Sürümleme
Paket sürüm türleri, değişiklik kaydı (changeset) yazımı, 0.x kuralı, bileşen durumları ve kullanımdan kaldırma.
Sürüm türleri
Bölüm başlığı “Sürüm türleri”@bigbang/tokens, @bigbang/ui ve @bigbang/icons anlamsal sürümleme kullanır ve Changesets ile sürümlenir. Doküman sitesi (@bigbang/docs) sürümlenmez.
| Değişiklik | 0.x boyunca |
1.0 sonrasında |
|---|---|---|
| Hata düzeltmesi, görünmeyen iç değişiklik | Düzeltme (patch) | Düzeltme (patch) |
| Yeni bileşen, özellik, varyant ya da token | Küçük (minor) | Küçük (minor) |
| Uyumu bozan değişiklik: özellik ya da token kaldırma veya adını değiştirme, varsayılanı ya da davranışı değiştirme | Küçük (minor), geçiş notuyla | Büyük (major), geçiş notuyla |
Paketler 0.x sürümünde olduğu sürece uyumu bozan değişiklik küçük sürümle yayımlanır. Bu yüzden her uyumu bozan değişikliğin metni bir geçiş notu içerir.
Değişiklik kaydı yazmak
Bölüm başlığı “Değişiklik kaydı yazmak”Kullanıcıların fark edebileceği her değişiklik bir değişiklik kaydıyla gelir:
pnpm changeset- Değişen paketleri ve sürüm türünü seçin.
- Bir ya da iki cümle yazın; değişikliği kullanan kişinin gözünden, İngilizce. Kod adlarını ters tırnak içinde yazın (
`Button`); Yenilikler sayfası bu adlardan bileşen sayfalarına bağlantı kurar. - Uyumu bozan değişiklikte eski ve yeni kullanımı yazın:
Rename `appearance` to `variant`: `appearance="subtle"` becomes `variant="tertiary"`. - Oluşan
.changeset/*.mddosyasını değişiklikle birlikte kaydedin.
Testler, doküman sitesi ve araçlar gibi kullanıcının fark etmeyeceği değişiklikler kayıt gerektirmez. pnpm changeset status bir sonraki sürüme girecekleri listeler. Sürüm numarasını yükseltmek (pnpm changeset version) ve yayımlamak bakımcıların işidir.
Bileşen durumları
Bölüm başlığı “Bileşen durumları”Durum, paket sürümünden ayrıdır ve Bileşenlere genel bakış tablosunda görünür.
| Durum | Anlamı | Bir sonraki duruma geçiş |
|---|---|---|
| Taslak | Kullanılabilir; arayüz değişebilir | Arayüz sabitlendi, kontrol listesi tamam |
| Beta | Arayüz sabit; ilk ürün kullanımı ve elle erişilebilirlik testi sürüyor | Ekran okuyucu testi yapıldı, iki ekranda kullanıldı |
| Hazır | Uyumu bozan değişiklik yalnızca büyük sürümle | — |
| Kullanımdan kalkıyor | Yerine geçen bileşen belirtildi | Bir sonraki küçük sürümde kaldırılır |
Kullanımdan kaldırma
Bölüm başlığı “Kullanımdan kaldırma”- Eski bileşen ya da özellik
@deprecatedTSDoc etiketiyle yerine geçeni gösterir (REUSE-10). - Durum “Kullanımdan kalkıyor” olur; Değişiklikler sekmesine kaldırma sürümü yazılır.
- Mümkünse bir kod dönüştürücü (codemod) eklenir.
- Kaldırma bir sonraki küçük sürümde yapılır. Kullanım bu sürede artıyorsa sürüm durdurulur.