Çekme istekleri — MRTK2

Önkoşullar

Daha önce bir Microsoft projesine katkıda bulunmadıysanız bir katkı lisans sözleşmesi imzalamanız istenebilir. Çekme isteğindeki bir yorum yaparsanız bunu size bildirir.

Önemli

Microsoft çalışanıysanız ve GitHub'daki Microsoft kuruluşunun üyesi değilseniz, çekme isteğinizi başlatmadan önce Microsoft'ta Açık Kaynak'ı ziyaret ederek corpnet'teki Microsoft ve GitHub hesaplarınızı bağlayın. Önceden yapmanız gereken bazı işlem öğeleri vardır.

Çekme isteği oluşturma

Çekme isteği göndermeye hazır olduğunuzda ana dalı hedefleyen bir çekme isteği oluşturun. Yayın dengeleme döneminde hata düzeltmeleri için en son prerelease/* dalı arayın. Yeni özelliklerin her zaman içine gitmesi maingerekir.

Yönergeleri okuyun ve çekme isteğinizin yönergeleri karşıladığından emin olun.

• Çekme isteğinin ilgili olduğu herhangi bir Sorun / Özellik İsteğine veya Göreve başvurarak emin olun.
• Çekme isteğinin yalnızca çekme isteğiyle ilgili dosyaları / değişiklikleri içerdiğini denetleyin.
• Belgelerin güncel olup olmadığını ve dahil olduğunu denetleyin. Tüm ortak alanların açıklamaları olup olmadığını denetleyin.
• Yeni bir özellik ekliyorsanız, özelliği doğrulamak için testlerin eklenip eklenmediğini denetleyin (bkz . UnitTests).
• Bir hatayı düzeltiyorsanız, hata düzeltmesini doğrulamak için bir test yazın.

Proje bakımcıları değişikliklerinizi gözden geçirir. Üç iş günü içinde tüm değişiklikleri gözden geçirmeyi hedefliyoruz. Lütfen gözden geçirme yorumlarını ele alın, konu dalınıza gönderin ve gözden geçirebilecek yeni şeyler olduğunu bize bildiren bir yorum gönderin.

Not

Projeye gönderilen tüm çekme isteği mrtk kodlama standartları kılavuzuna göre de incelenir, bu nedenle sorunsuz bir süreç sağlamak için çekme isteğinizi göndermeden önce lütfen bunları gözden geçirin.

Çekme isteği yönergeleri

Bu yönergeler , Google'ın mühendislik uygulamalarını temel alır.

Çekme isteklerini küçük tutma

Daha küçük PR'ler daha hızlı ve ayrıntılı bir şekilde gözden geçirilir, hata verme olasılığı daha düşüktür, geri alınması daha kolay ve birleştirmesi daha kolaydır.

Çekme istekleri, mühendisin 30 dakikadan kısa bir süre içinde gözden geçirebileceği kadar küçük olmalıdır. Tek bir şeyi ele alan en düşük düzeyde bir değişiklik yapmayı deneyin. Büyük bir çekme isteği oluşturmanız gerekiyorsa, bunu yerel dalınıza veya MRTK'nın bir özellik dalı içine giden birkaç PR'ye bölün. Yeni varlıklar (örneğin, fbx, obj dosyaları) eklemekten kaçının ve bunun yerine mevcut varlıkları yeniden kullanmayı hedefleyin.

Acil durumlar dışında testler düzeltmenizle / özelliğinizle aynı pr'ye eklenmelidir

Testler, değişikliklerin mevcut kodu gerilemediğinden emin olmak için en iyi yoldur, ancak çekme istekleri gönderirken testleri unutmak da kolaydır. Çekme isteğinizle girmelerini gerektirmek, testlerin yazılmasını sağlamanın harika bir yoludur.

Her özellik ve hata düzeltmesiyle ilişkilendirilmiş testler olmalıdır. Test yazmak için yeterli uzmanlığınız veya vaktiniz yoksa testleri yazmak için bir sorun oluşturun ve Bunları Geçerli Yineleme için Değerlendir etiketiyle işaretleyin.

Belgeler, düzeltme / özellik ile aynı çekme isteğine eklenmelidir

Geliştiricilerin çoğu, bir özelliğin nasıl kullanılacağını anlarken önce koda değil belgelere bakar. Belgelerin güncel olduğundan emin olmak, kişilerin MRTK'yi kullanmalarını ve kullanmalarını çok daha kolay hale getirir. Belgelerin her zaman ilgili çekmeyle birlikte paketlenmesi ve öğelerin güncel ve tutarlı kalmasını sağlamak gerekir.

Docfx sitemizin alanlar/ yöntemler için açıklamalar oluşturabilmesi için her ortak alan, yöntem, özellik için üçlü eğik çizgi özet açıklamaları olduğundan emin olun. Gerekirse, Belgeler klasöründe markdown dosyalarını güncelleştirin.

Çekme isteği açıklamaları değişiklikleri açıkça ve tamamen açıklamalıdır

Çekme isteklerinin net ve eksiksiz açıklamaları, gözden geçirenlerin neleri gözden geçirdiklerini anlamasını sağlar.

UX içeren özellikler ekliyorsanız, değiştirdiğiniz özelliğin görüntüsünü / gif'ini ekleyin. İşte iyi bir örnek. Bir diğer öneri de, örneğin bu çekme isteğinde Önce ve Sonra gif'ine sahip olmaktır. Ekran yakalamalarından gif oluşturmak için önerdiğimiz bir araç ScreenToGif'tir.