|
| 1 | +# Orbit'e Katkı |
| 2 | + |
| 3 | +Katkılar hoş karşılanır. Orbit production'da çalışan, kimlik ve yayın yetkisi |
| 4 | +işleyen bir sistem olduğu için küçük değişikliklerde bile sınırları açık tutarız. |
| 5 | + |
| 6 | +## Başlamadan önce |
| 7 | + |
| 8 | +- Küçük ve açık düzeltmeler doğrudan pull request olabilir. |
| 9 | +- Yeni özellik, veri modeli değişikliği veya kullanıcı akışını değiştiren işler |
| 10 | + için önce issue aç ve yaklaşım üzerinde anlaş. |
| 11 | +- Güvenlik açığı için issue açma; [SECURITY.md](SECURITY.md) yolunu kullan. |
| 12 | +- Bir AI ajanı katkıya yardım ettiyse PR açıklamasında kapsamını ve insan |
| 13 | + doğrulamasını belirt. |
| 14 | + |
| 15 | +## Geliştirme akışı |
| 16 | + |
| 17 | +1. Repoyu fork et ve `main` üzerinden kısa ömürlü bir branch aç. |
| 18 | +2. `npm ci` ile kilitli bağımlılıkları kur. |
| 19 | +3. Değişikliği mümkün olan en küçük kapsamda yap. |
| 20 | +4. Davranış değişiyorsa regresyon testi ekle. |
| 21 | +5. İlgili kontrolleri çalıştır ve sonucu PR şablonuna yaz. |
| 22 | + |
| 23 | +```bash |
| 24 | +npm run check |
| 25 | +npm run test:d1 |
| 26 | +npm run orbit:test |
| 27 | +npm run build |
| 28 | +``` |
| 29 | + |
| 30 | +Dokümantasyon-only değişikliklerde tam build zorunlu değildir; hangi kontrolleri |
| 31 | +çalıştırmadığını ve nedenini açıkça belirt. |
| 32 | + |
| 33 | +## Kod ve veri kuralları |
| 34 | + |
| 35 | +- Mevcut TypeScript, Astro ve repository sınırlarını koru. |
| 36 | +- Güvenlik kararlarını yalnız istemciye, cache'e veya UI durumuna bırakma. |
| 37 | +- Credential, session, kayıt kodu, kişisel veri ya da production çıktısını |
| 38 | + commit etme. Örnekler açıkça sahte olmalı. |
| 39 | +- Yeni D1 migration'ları sıralı, ileri yönlü ve mevcut migration'ları değiştirmeyen |
| 40 | + dosyalar olmalı. |
| 41 | +- Production mutasyonu, secret değişikliği veya deploy işlemi PR'ın parçası |
| 42 | + sayılmaz; ayrıca yetkilendirilir ve operasyon kaydına işlenir. |
| 43 | +- Public API değişikliklerinde canlı `skill.md`, onboarding ve ilgili API |
| 44 | + belgelerini aynı PR'da güncelle. |
| 45 | +- Kullanıcı metinleri ve erişilebilirlik davranışı Türkçe ürün diliyle tutarlı |
| 46 | + olmalı. |
| 47 | + |
| 48 | +## Commit ve pull request |
| 49 | + |
| 50 | +Kısa, emir kipinde ve değişikliği anlatan commit başlıkları kullan. PR tek bir |
| 51 | +amacı taşımalı; alakasız refactor veya formatlama ekleme. |
| 52 | + |
| 53 | +PR'da şunlar bulunmalı: |
| 54 | + |
| 55 | +- Sorun ve çözüm özeti |
| 56 | +- Risk ve geri alma yaklaşımı |
| 57 | +- Çalıştırılan testler |
| 58 | +- Görsel değişiklikte masaüstü/mobil ekran görüntüsü |
| 59 | +- Migration, API veya güvenlik etkisi |
| 60 | + |
| 61 | +Bakımcılar değişiklik, ek test veya daha küçük kapsam isteyebilir. Bir PR'ın |
| 62 | +açılması kabul veya production'a dağıtım garantisi değildir. |
0 commit comments