Script yayınlama rehberi
İyi belgelenmiş bir script daha kolay kurulur, daha az destek yükü oluşturur ve topluluk tarafından daha güvenli değerlendirilir.
Yayın kontrol listesi
Bölüm başlığı “Yayın kontrol listesi”- Scriptin amacını bir paragrafta açıkla.
- Desteklenen platform ve sürümleri belirt.
- Tüm bağımlılıkları bağlantılarıyla listele.
- Kurulum ve yapılandırma adımlarını ekle.
- Lisansı ve yeniden dağıtım koşullarını açıkça yaz.
- Ekran görüntüsü veya kısa bir kullanım örneği ekle.
- Bilinen sorunları ve değişiklik günlüğünü paylaş.
Güvenlik
Bölüm başlığı “Güvenlik”Yayın paketinde erişim anahtarı, veritabanı parolası, webhook adresi veya gerçek kullanıcı verisi bırakma. Üçüncü taraf kodları lisansını kontrol etmeden pakete dahil etme.
Önerilen README yapısı
Bölüm başlığı “Önerilen README yapısı”# Script adı
Kısa açıklama
## Gereksinimler## Kurulum## Yapılandırma## Kullanım## Değişiklik günlüğü## Lisans