İyi Bir Sorun Yazma

Başarılı projelerin hepsi kullanıcı geri bildirimlerine dayanır. Blockly, geri bildirimleri izlemek için GitHub sorunlarını kullanır. Bu sayfada, geliştiricinin kolayca okuyabileceği ve yanıtlayabileceği bir sorunun nasıl yazılacağı ayrıntılı bir şekilde anlatılmıştır. Bu da hata raporunuzun/özellik isteğinizin ele alınma olasılığını artırır!

Çalışma öncesi

Sorunuz var mı?

Sorularınızı duymak bizi mutlu ediyor. Ancak GitHub sorunları onlar için çok iyi bir ortam değil. Sorunuz varsa geliştirici forumumuzu ziyaret edebilirsiniz. Sorunuzu burada sorduğunuzda zamanında ve kapsamlı yanıt alma olasılığınız artar, çünkü yıllardır Blockly'yi kullanan geliştiricilerle dolu!

Yinelenenleri Kontrol Edin

Herhangi bir sorun yazmaya başlamadan önce eşleşen bir sorunun zaten olup olmadığını görmek her zaman iyi bir fikirdir. Böylece, yazma zahmetinden kaçınma zahmetinden kurtulursunuz. Bu nedenle, yazmaya başlamadan önce kopyalar veya ilgili konularla ilgili birkaç arama yapın.

Eşleşen bir sorun bulursanız beğenme işareti yapın veya düşüncelerinizi açıklayan bir yorum ekleyin. Bu, özellikle hata raporları ve özellik istekleri için önemlidir. Geliştiriciler bir sorunun çok dikkat çektiğini görürlerse üzerinde çalışılma ihtimali de artar.

Hata Bildir

Bir hata mı buldunuz? İsteğinizi aldık. Hata raporlarını duymaktan hoşlanıyoruz çünkü bu projenin mümkün olduğunca istikrarlı olmasını istiyoruz. Hatanızın düzeltilmesine yardımcı olmak için uygulayabileceğiniz bazı adımları burada bulabilirsiniz.

  1. Kopyaları kontrol edin
  2. Kanıt Toplayın
  3. Sorunu Bulun
  4. Yeniden üretiminizi sadeleştirin
  5. Bir Amaç Önerin
  6. Sorununuzu yazın

Kanıt Toplayın

Genellikle, hatanızla ilgili ne kadar fazla bilgi olursa o kadar iyi olur. Verebileceğiniz bazı konulardan bazıları şunlardır:

  • Bir hata görsel olarak soruna neden oluyorsa Ekran Görüntüleri veya GIF'ler çok yararlı olabilir.
  • Örnek Kod, bir hata yalnızca belirli blok türlerini veya çalışma alanı yapılandırmalarını etkiliyorsa yararlıdır.
  • Barındırılan Site, sahip olduğunuz hatanın belirli bir ortam dışında yeniden oluşturulmasında sorun yaşıyorsanız çok iyi bir çözümdür.

Sorunu Bulun

Çekirdek kitaplık, eklentiler, örnekler ve codelab'ler arasında çok fazla Blockly kodu var. Sorunun tam olarak nerede olduğunu söyleyerek bize yardımcı olun.

Sorun temelde ise hangi bileşende görülüyor? Örneğin, sorun araç kutusu, yakınlaştırma kontrolleri veya kitaplık bloklarıyla ilgili olabilir. Olabildiğince ayrıntılı bilgiler verin.

Sorun blok halinde örneklerdeyse hangi eklenti, codelab veya örnekte bulunduğunu bulun. Aynı hatayı birden fazla yerde bulursanız bize de bildirin.

Çoğaltma işleminizi sağlamlaştırın

Bir hata yalnızca yeniden oluşturulabiliyorsa düzeltilebilir. Bu nedenle, sorunu göndermeden önce hatanın ortaya çıkması için sağlam bir yönteme sahip olduğunuzdan emin olun.

Geliştiriciye hatanın nasıl yeniden üretileceğini anlatan, adımların numaralı bir listesini elde etmeniz gerekir. Örneğin:

  1. X codelab'ini açın.
  2. Y sayfasına git.
  3. Z örnek kodunu çalıştırın.
  4. W gibi görünen kötü davranışı gözlemleyin.

Sorununuz Blockly core'daysa playground yeniden oluşturmaya çalışın.

Bir Amaç Öner

Hatanın neden oluştuğunu bildiğinizi düşünüyorsanız bu bilgiyi de ekleyin. Yine mümkün olduğunca ayrıntılı bilgi verin.

Sorununuzu yazın.

Hata raporunuzu yazmanın zamanı geldi. Kod deponuzu seçin:

Burada ayrıntılı bilgi verilmeyenler de dahil olmak üzere sorun şablonunun tüm bölümlerini doldurduğunuzdan emin olun.

Hata bildirmeye gösterdiğiniz ilgi için teşekkür eder, iyi bir sorun yazısı yazmanızı dileriz.

Sıradaki adım:

  • Hata raporunuz, önceliklendirme için otomatik olarak etiketlenir.
  • Blockly ekibinin nöbetçi üyesi konuya bakacak ve muhtemelen açıklayıcı sorular soracak. Ayrıca, hatalarımızı düzenli tutmak için kullandığımız etiketler de ekleyecekler.
  • Sorun "Yardım İstendi" olarak işaretlenmiş olabilir. Bu durumda hak talebinde bulunabilir ve üzerinde çalışmaya başlayabilirsiniz.
  • Sorun, düzeltilmesi için Blockly ekibinin bir üyesine atanabilir.
  • Sorun, ne zaman biteceğini belirtmek için üç aylık bir ara hedefle işaretlenebilir.
  • Sorun, Icebox ara hedefinde ele alınmış olabilir. Diğer bir deyişle, öngörülebilir bir gelecekte bu konu üzerinde çalışmayı düşünmüyoruz.
    • Bu durum, düşük sıklıkta sorunlar veya bilinen geçici çözümleri olan hatalarda yaşanabilir.
    • Buz Kutusu ile ilgili sorunlar üzerinde çalışmaya devam edebilirsiniz.
  • Sorun, Bug Bash İş Listesi ara hedefine yerleştirilebilir. Diğer bir deyişle, acil değildir, ama yine de bu sorunu düzeltmek isteriz.
    • Her üç aylık dönemin sonunda ekip, Bug Bash İş Listesi ara hedefinden çıkarılan hatalar üzerinde çalışmak için birkaç hafta harcar.
  • Gerekirse sorun, Blockly çekirdekten bloklu örneklere (veya tam tersi) taşınabilir.
  • Bu sorun kapanmış olabilir.

Özellik İsteği

Blockly'yi daha iyi hale getirmek için değiştirmek istediğiniz bir şey var mı? Eklenti, örnek veya codelab ile ilgili bir fikriniz var mı? Belki de beğendiğiniz bir video vardır ve bunu iyileştirmenin bir yolunu buldunuz. Öyleyse doğru yere geldiniz! Yanıt alan güzel bir özellik isteği oluşturmanıza yardımcı olacak adımları burada bulabilirsiniz.

  1. Kopyaları kontrol edin
  2. Koşulları kontrol edin
  3. Düşüncelerinizi Toplayın
  4. Özellik İsteğinizi yazın

Koşulları kontrol edin

Tüm fikirlerin bu veri havuzuna girmesine izin vermek istiyoruz. Ama ne yazık ki yalnızca insan olduğumuz için ne tür taleplerin peşinden gideceğimiz konusunda bazı yönergelerimiz var.

Her bir farklı proje kategorisi için yönergeler aşağıda verilmiştir:

  • Blockly core
  • Eklentiler
  • Örnekler: Yalnızca bir veya iki Blockly özelliğinin nasıl kullanılacağını gösterin.
  • Codelab'ler: Tek bir görevin nasıl tamamlanacağını veya tek bir davranışın nasıl uygulanacağını gösterir.

Ancak bunlar zor ve hızlı kurallar değil. Bu raporların amacı, özellik isteğinizi oluşturmaya zaman ayırmadan önce nelere dikkat ettiğimize dair size bir fikir vermektir.

Bir içeriğin uygun olup olmadığından emin değilseniz geliştirici forumlarımızda yayınlamayı deneyin. Fikriniz kabul edilmese bile, üçüncü taraf bir eklenti veya eğitim olarak geliştirmenizi çok isteriz.

Düşüncelerinizi Toplayın

Fikrinizin devam edip göndermeden önce rengarenk ve diyagramlarla donatılmış olması gerekmez. Ancak ne aradığınıza dair somut bir fikriniz olmalıdır. Yazmaya başlamadan önce düşünebileceğiniz bazı iyi sorular aşağıda verilmiştir:

  • Neden bu özelliği kullanmak istiyorum?
  • Bu özellik bir sorunu çözüyor mu?
  • Bu özelliğin hedef kitlesi kim?
  • Bu özellik müşterilere neden hizmet ediyor?
  • Aynı şeyi başarmanızı sağlayacak alternatif seçenekler neler?

Tüm bunları çözdükten sonra, iyi bir özellik isteğine geçmenin en etkili yoludur.

Özellik İsteğinizi yazın!

Artık özellik isteğinizi yazmaya hazırsınız. Kod deponuzu seçin:

Burada ayrıntılı bilgi verilmeyenler de dahil olmak üzere sorun şablonunun tüm bölümlerini doldurduğunuzdan emin olun.

Özellik isteği gönderme konusunda gösterdiğiniz ilgi için teşekkür eder, sorunlarınızı yazmaktan memnun kalmanızı dileriz.

Sıradaki adım:

  • Özellik isteğiniz, önceliklendirme için otomatik olarak etiketlenir.
  • Blockly ekibinin nöbetçi üyesi konuya bakacak ve muhtemelen açıklayıcı sorular soracak. Ayrıca, hatalarımızı düzenli tutmak için kullandığımız etiketler de ekleyecekler.
  • Özellik, "Yardım İsteniyor" olarak işaretlenebilir. Bu durumda özelliği talep edip üzerinde çalışmaya başlayabilirsiniz.
  • Bu özellik, uygulanması için Blockly ekibinin bir üyesine atanabilir.
  • Özellik isteği, gerekirse Blockly çekirdekten bloklu örneklere (veya tam tersi) taşınabilir.
  • Özellik isteği kapatılabilir. Bu durumda, özelliği üçüncü taraf eklentisi olarak uygulayabilirsiniz.