Pull istekleri, bir deponun yaşam kaynağıdır. Her şeyin sağlıklı ve hareketli kalmasını sağlarlar. Bu sayfada, eksiksiz ve incelemesi kolay bir PR oluşturma hakkında ayrıntılı bilgi verilmektedir. Bu sayede, PR'nizin birleştirilmesi olasılığı artar.
Mümkün olan en iyi halkla ilişkileri oluşturmak için uygulayabileceğiniz adımlar aşağıda verilmiştir.
İletişim
Hemen işe koyulup kod yazmaya başlamadan önce, ilgilendiğiniz konuları anlamaları için çekirdek ekiple iletişime geçmeniz faydalı olur.
İlgilendiğiniz bir sorun varsa bu sorunla ilgili olarak üzerinde çalışmaya başlayacağınızı belirten bir yorum bırakın. Bu sayede aynı konu üzerinde birden fazla kişinin çalışmasını önleriz. Bir ekip üyesi, bu cihazın size ait olduğunu onaylamak için yanıt verir.
Bir sorunla ilgili olmayan bir fikriniz varsa lütfen çalışmaya başlamadan önce bir sorun kaydet. Bu sayede ekip, geliştirmeye başlamadan önce değişikliğin en iyi şekilde nasıl oluşturulacağını tartışabilir. Bu da uzun vadede size zaman kazandırır.
Hazırlanın
Blockly veya blockly-samples'e ilk kez katkıda bulunuyorsanız geliştirme kurulumu sayfasından başlayın.
Küçük tutun
Değişikliklerinizi her zaman küçük ve odaklanmış tutmaya çalışın. Tek bir büyük PR'den ziyade birden fazla küçük PR'yi incelemeyi tercih ederiz. Faydalı olabilecek bazı kurallar şunlardır:
- Bir sorunu düzeltin. Aynı anda birden fazla sorunu çözmeye çalışmayın.
- Kapsamı sınırlayın. PR'ler genellikle 8 saatten kısa sürer (kod tabanına aşinalığınıza bağlı olarak).
- Commit'leri kullanın. PR'niz biraz büyükse git commit'lerini kullanarak değişiklikleri mantıksal gruplara ayırın.
Temiz bir dil kullanın
Kod stili neden önemlidir? Uzun vadeli bir iş yapıyoruz ve tutarlı bir stil, bakım sürecini kolaylaştırır. Stil, değişkenlerinizi nasıl adlandırdığınızı ifade eder ancak kodunuzu nasıl yapılandırdığınızı, yorumları nasıl yazdığınızı ve daha fazlasını da kapsar. Mümkün olduğunda stil kontrollerini otomatikleştirmek için eslint gibi araçlar kullanırız.
eslint'e ek olarak lütfen aşağıdaki kılavuzları da uygulayın:
Değişikliğinizi test etme
PR göndermeden önce, değişikliklerinizin çalıştığını her zaman test etmeniz gerekir. Böylece, daha sonra geri dönüp düzeltme yapmanız gerekmez. Farklı proje kategorilerini test etmek için bazı fikirler:
- Eklentiler için: Değişikliklerinizi kapsayan otomatik Mocha testleri yazın.
- Örnekler: Gösterilen tüm işlevlerinizi manuel olarak test edin.
- codelabs için: Eğitimin tamamını temiz bir ortamda çalıştırın ve sağladığınız örnek kodları test edin.
İletişim
Bu, PR oluşturmanın son ve tartışmasız en önemli kısmıdır: Özet yazma.
Mükemmel bir halkla ilişkiler özeti yazmak, diğer geliştiricilerin değişikliklerinizi incelemesine yardımcı olur ve bu da değişikliklerinizin daha hızlı kabul edilme olasılığını artırır.
Özetiniz şunları içermelidir:
- Halkla ilişkiler çalışmanızın hangi konuyla ilgili olduğunu belirtin.
- Halkla ilişkiler çalışmanızın ne gibi bir değişiklik sağladığı.
- Değişikliğinizi nasıl test ettiğinizi belirtin.
- İnceleme uzmanlarının ayrıntılı olarak incelemesini istediğiniz her şey.
- İnceleme uzmanlarının ihtiyaç duyduğunu düşündüğünüz diğer bilgiler.
İsteğinizi oluştururken PR şablonunu uygularsanız sorun yaşamazsınız. Yalnızca mümkün olduğunca özet ve tam bir açıklama yazmayı unutmayın.
Keyifli kodlamalar dileriz.