Çekme isteği incelemesi sağlama¶
Katkıda bulunanların deneyim düzeyleri ne olursa olsun, onların yorumlarını her zaman memnuniyetle kabul ederiz.
Neden katkıları gözden geçirmelisiniz?¶
Gönderilen her katkı, ister çekirdek ekip üyesi ister ilk kez katkı sağlayan kişi tarafından gönderilmiş olsun, incelenmelidir. Herkesin bir şeyi gözden kaçırma olasılığı vardır. İnceleme süreci, ek bir güvenlik ağı sağlamak için uygulanmaktadır.
İnceleme sürecinin amacı, kod ve belgeler dahil olmak üzere tüm içeriğin mümkün olduğunca hatasız ve bakımı kolay olmasını sağlamaktır. Bu hedefe ulaşmak için yapabileceğiniz her şey memnuniyetle karşılanacaktır. Bu, yazım hatasını düzeltmek gibi basit bir şeyden, API kullanımında yakalanamayan uç durumları bulmaya kadar uzanabilir. Test rejiminin daha sağlam hale getirilebileceği yolları belirleyebilir veya değişikliklerin genel mimarisini, bakımı veya genişletilmesi daha kolay olacak şekilde yapılandırmak için önerilerde bulunabilirsiniz.
İnceleme yapabilir miyim?¶
Evet! BeeWare üzerinde açık olarak gördüğünüz herhangi bir çekme isteği hakkında yorum yapabilirsiniz.
İlk kez katkıda bulunan biri olarak, çekirdek ekip üyesi tarafından gönderilmiş olsa bile, bulduğunuz herhangi bir çekme isteğini gözden geçirmekten çekinmemelisiniz. Acemiyseniz, bazı büyük proje bağlamlarını kaçırabilirsiniz; ancak deneyim düzeyiniz ne olursa olsun, kod tabanını erişilebilir tutmayı amaçlıyoruz. Kodda mantıksız bir şey varsa, bu daha fazla dokümantasyona (kodda veya bağımsız tasarım dokümantasyonu olarak) ihtiyaç olduğunu gösterebilir.
Çekme isteği incelemesine katkıda bulunma¶
Çekme isteği incelemesi sağlama
BeeWare projesine yapılan tüm katkıları herkes inceleyebilir. Başlamadan önce dikkat edilmesi gereken bazı önemli hususlar vardır.
İncelemeden önce DÜŞÜNÜN¶
İncelemeye başlamadan önce DÜŞÜNÜN. İnceleme yapanlar olarak, göndermek üzere olduğumuz yanıtın aşağıdaki özelliklere sahip olup olmadığını düşünmeliyiz:
- Doğru. Her zaman doğru öneriler ve bilgiler sunmaya çalışın.
- Yararlı. Gönderimin nasıl iyileştirilebileceğine dair rehberlik sağlıyoruz; bu rehberlik, sorunun kaynağını veya gözden kaçan kullanım durumunu açıkça belirlemeli ve ideal olarak, sorunu çözecek veya endişeyi giderecek bir yol sunmalıdır.
- İlham verici. Yazarın talep ettiğimiz değişiklikleri yapmak istemesini sağlamak bizim elimizde.
- Gerekli. Yazarın yayınladığımız her şeyi okuyacağı beklentisi vardır; sadece gerekli olduğunda yayın yaparak onların zamanına ve çabalarına saygı göstermeliyiz.
- Nazik. Aynı geri bildirimi sunmanın birçok yolu vardır; sözlerimizle nazik, destekleyici ve yapıcı olmayı seçtiğimizden emin olmalıyız.
Etkili bir inceleme yaparken aynı zamanda DÜŞÜNMEK de mümkündür. Yukarıda tartışılan kavramlar, bir PR'da bulduğunuz sorunları belirtmenizi engellemez. Katkıda bulunanlar, iyileştirilmesi gereken alanların farkında değillerse katkılarını iyileştirme fırsatı bulamazlar. Önemli olan, bu geri bildirimi nasıl sunduğunuzun farkında olmaktır. İncelemenizi kişiselleştirmeyin. "Hata yaptınız" demek yerine, "Bu kod iyileştirilebilir" diyebilirsiniz. Yazarı değil, kodu inceleyin.
İyileştirilmesi gereken alanları belirlemenin yanı sıra olumlu geri bildirimde bulunmayı da unutmamak önemlidir. Örneğin, değişiklikler özellikle yararlıysa, özellikle akıllıca bir şey yapıyorsa veya bilmediğiniz bir API ile tanıştırılıyorsanız, bunu yazara bildirin! Her şeyi doğru veya iyi yaptığı bir şeyi, diğer her şeyi çözülmesi gereken sorunlar olarak işaretlediğiniz bir durumda işaret etmenin etkisini asla küçümsemeyin.
GitHub inceleme önerileri¶
GitHub inceleme arayüzü, mevcut içeriğin yerine önerdiğiniz değişikliği tam olarak belirtebileceğiniz bir değişiklik öneri mekanizmasına sahiptir. Kabul edilip uygulanana kadar, önerilen bu değişiklikler ön uygulama ve linting kontrollerinden geçmeyecektir. Bu nedenle, bu özellik daha küçük değişiklikler için kullanılmalıdır, çünkü önerilen değişiklik ne kadar büyükse, sorunlara yol açma olasılığı da o kadar artar.