Yönetim rehberi
Bir quest paylaşımının kullanılabilir olması için yalnız kod yeterli değildir. Okuyucu paylaşımın amacını, hangi ortamda denendiğini, kurulumun neyi değiştirdiğini ve nasıl geri alınacağını anlayabilmelidir. Bu rehber paylaşım açıklamasını hazırlamak için bir kontrol listesi sunar. Her sunucuda çalışan bir kurulum yöntemi veya herhangi bir paketin güvenli olduğuna dair onay içermez.
1. Amacı ve paylaşım hakkını açıklayın
İlk paragrafta kodun ne yaptığını ve ne yapmadığını sade biçimde anlatın. Kod size aitse bunu belirtin. Başkasının çalışmasını paylaşıyorsanız kaynak bağlantısını ve izin ya da lisans bilgisini ekleyin; kaynağı göstermek tek başına yeniden dağıtım izni anlamına gelmez. Paylaşma hakkınız belirsizse dosyayı yeniden yüklemek yerine özgün kaynağa yönlendirin. Katkı yaptığınız bölüm ile özgün çalışmayı birbirinden ayırın.
2. Test bilgisini somut yazın
“Sorunsuz çalışıyor” yerine hangi sürüm veya ortamda, hangi işlemle denediğinizi açıklayın. Sürüm bilgisi bilinmiyorsa bunu saklamayın. Hiç çalıştırmadığınız kodu “test edilmedi” olarak işaretleyin. Bir örneğin başarıyla tamamlanması bütün olasılıkların sınandığını göstermez; bilinen sınırlamaları ve henüz denenmemiş durumları ayrı yazın. Başka üyelerden gelen sonuçları kendi testinizmiş gibi sunmayın.
3. Kurulumdan önce geri dönüş yolunu tarif edin
Değişecek dosyaları ve varsa veri değişikliğini listeleyin. Okuyucunun kendi ortamına uygun yedeği almasını ve önce ayrı bir test ortamında denemesini önerin. Üretim sunucusunda doğrudan çalıştırılacak, bağlamı açıklanmamış komutlar vermeyin. Dosya geri yüklemenin, kodun oluşturduğu veri değişikliklerini kendiliğinden geri almayabileceğini belirtin. Geri alma adımını bilmiyorsanız eksikliği açıkça yazın; çözüm varmış gibi göstermeyin.
4. Paylaşım gövdesi için kısa şablon
Şablonu gerçek bilgilerle doldurun; bilinmeyen alanlara tahmin eklemeyin. Kod kısa ise açıklamayla birlikte kod bloğunda paylaşın. Uzun bir dosya ekliyorsanız dosya adını, sürümünü ve hangi amaca hizmet ettiğini yazın. İndirme bağlantısının nereye gittiği anlaşılır olsun. Sunucu parolası, erişim anahtarı, gerçek oyuncu verisi veya özel yapılandırma dosyasını pakete dahil etmeyin.
5. Güncellemeyi izlenebilir tutun
Yeni sürümde değişen davranışı, düzeltilen sorunu ve eski sürümden geçişte gereken adımları aynı konuda belirtin. Eski bir dosyayı sessizce değiştirip bütün yorumları yeni sürüme aitmiş gibi bırakmayın. Hata bildiren üyeden kullandığı sürümü ve sorunu oluşturan adımları isteyin. Bu düzen, paylaşımı inceleyen kişiye neyi test edeceğini gösterir ve tekrarlanan soruları azaltmaya yardımcı olur.
Bir quest paylaşımının kullanılabilir olması için yalnız kod yeterli değildir. Okuyucu paylaşımın amacını, hangi ortamda denendiğini, kurulumun neyi değiştirdiğini ve nasıl geri alınacağını anlayabilmelidir. Bu rehber paylaşım açıklamasını hazırlamak için bir kontrol listesi sunar. Her sunucuda çalışan bir kurulum yöntemi veya herhangi bir paketin güvenli olduğuna dair onay içermez.
1. Amacı ve paylaşım hakkını açıklayın
İlk paragrafta kodun ne yaptığını ve ne yapmadığını sade biçimde anlatın. Kod size aitse bunu belirtin. Başkasının çalışmasını paylaşıyorsanız kaynak bağlantısını ve izin ya da lisans bilgisini ekleyin; kaynağı göstermek tek başına yeniden dağıtım izni anlamına gelmez. Paylaşma hakkınız belirsizse dosyayı yeniden yüklemek yerine özgün kaynağa yönlendirin. Katkı yaptığınız bölüm ile özgün çalışmayı birbirinden ayırın.
2. Test bilgisini somut yazın
“Sorunsuz çalışıyor” yerine hangi sürüm veya ortamda, hangi işlemle denediğinizi açıklayın. Sürüm bilgisi bilinmiyorsa bunu saklamayın. Hiç çalıştırmadığınız kodu “test edilmedi” olarak işaretleyin. Bir örneğin başarıyla tamamlanması bütün olasılıkların sınandığını göstermez; bilinen sınırlamaları ve henüz denenmemiş durumları ayrı yazın. Başka üyelerden gelen sonuçları kendi testinizmiş gibi sunmayın.
3. Kurulumdan önce geri dönüş yolunu tarif edin
Değişecek dosyaları ve varsa veri değişikliğini listeleyin. Okuyucunun kendi ortamına uygun yedeği almasını ve önce ayrı bir test ortamında denemesini önerin. Üretim sunucusunda doğrudan çalıştırılacak, bağlamı açıklanmamış komutlar vermeyin. Dosya geri yüklemenin, kodun oluşturduğu veri değişikliklerini kendiliğinden geri almayabileceğini belirtin. Geri alma adımını bilmiyorsanız eksikliği açıkça yazın; çözüm varmış gibi göstermeyin.
4. Paylaşım gövdesi için kısa şablon
Kod:
Amaç ve kapsam:
Yazar / kaynak / paylaşım izni:
Gerekli ortam ve bağımlılıklar:
Değişecek dosyalar ve varsa veriler:
Kurulum adımları:
Deneme adımları ve beklenen sonuç:
Gerçekleşen test sonucu:
Bilinen sınırlar:
Geri alma adımları:Şablonu gerçek bilgilerle doldurun; bilinmeyen alanlara tahmin eklemeyin. Kod kısa ise açıklamayla birlikte kod bloğunda paylaşın. Uzun bir dosya ekliyorsanız dosya adını, sürümünü ve hangi amaca hizmet ettiğini yazın. İndirme bağlantısının nereye gittiği anlaşılır olsun. Sunucu parolası, erişim anahtarı, gerçek oyuncu verisi veya özel yapılandırma dosyasını pakete dahil etmeyin.
5. Güncellemeyi izlenebilir tutun
Yeni sürümde değişen davranışı, düzeltilen sorunu ve eski sürümden geçişte gereken adımları aynı konuda belirtin. Eski bir dosyayı sessizce değiştirip bütün yorumları yeni sürüme aitmiş gibi bırakmayın. Hata bildiren üyeden kullandığı sürümü ve sorunu oluşturan adımları isteyin. Bu düzen, paylaşımı inceleyen kişiye neyi test edeceğini gösterir ve tekrarlanan soruları azaltmaya yardımcı olur.
