Aracılığıyla paylaş


Çekme isteklerini yönetme

Bu makale, PowerShell-Docs deposunda pull isteğini nasıl yönettiğimizi belgeler. Bu makale, PowerShell-Docs ekibi üyeleri için bir iş yardımı olacak şekilde tasarlanmıştır. Genel katkıda bulunanlarımıza süreç şeffaflığı sağlamak için bu bilgileri burada yayımlıyoruz.

En iyi yöntemler

  • Gözden geçirme isteğinde bulun. Çekme isteğini gönderen kişi, çekme isteğini eş gözden geçirme olmadan birleştirmemelidir.
  • Çekme isteği gönderildiğinde meslektaş inceleyiciyi atayın. Erken atama, değerlendiricinin editoryal yorumlarla daha erken yanıt vermesini sağlar.
  • Gönderilen değişikliğin niteliğini açıklamak için açıklamaları kullanın. Örneğin, değişiklik küçükse değişikliği açıklayın ve tam bir teknik incelemeye ihtiyacınız olmadığını açıklayın. İnceleyeni @mention olduğundan emin olun.
  • Yazarın önerilen değişikliği kabul etme işlemini kolaylaştırmak için açıklama önerisi özelliğini kullanın. Daha fazla bilgi için Çekme isteğinde önerilen değişiklikleri gözden geçirme bölümüne bakın.

Çekme İsteği Süreci adımları

  1. Yazan: Çekme İsteği Oluştur
    • Hİ şablonunu doldurun
    • PR tarafından çözülen herhangi bir sorunu bağlayın
    • Sorunu kapatmak için GitHub'ın otomatik kapatma özelliğini kullanma
    • Kontrol listesindeki her öğeyi çalışarak gözden geçirin ve tamamlayın.
  2. Yazar: Eş değer incelemeci atanması
  3. Gözden Geçiren: düzeltir ve yorum yapar (gerektiği gibi)
  4. Yazar: Gözden geçirme geri bildirimlerini dahil edin
  5. Her ikisi: Önizleme oluşturmayı gözden geçirme
  6. Her İkisi: Doğrulama raporunu gözden geçirme - uyarıları ve hataları düzeltme
  7. Yorumcu: incelemeyi "Onaylandı" olarak işaretle
  8. Depo Yöneticisi: Çekme isteğini birleştir

İçerik İnceleyici Kontrol Listesi

Daha kapsamlı bir liste için editoryal denetim listesine bakın.

  • Dil bilgisi, stil, özlülük ve teknik doğruluk açısından metni gözden geçirme
  • Örneklerin hedef sürüm için geçerli olduğundan emin olun
  • Önizleme görüntülenmesini kontrol etme
  • Meta verileri denetleme - ms.date, ms.assetid'yi kaldırın, gerekli alanlardan emin olun
  • Markdown doğruluğunu doğrulama
    • İçeriğe özgü biçimlendirme kuralları için stil kılavuzuna bakın
  • Örnekleri aşağıdaki gibi yeniden düzenleme:
    • Giriş paragrafı
    • Kod ve çıkış
    • Kodun ayrıntılı açıklaması (gerektiği gibi)
  • Bağlantıların doğruluğunu kontrol et
    • TechNet/MSDN bağlantılarını değiştirme veya kaldırma
    • Hedefe en az sayıda yeniden yönlendirme olduğundan emin olun
    • HTTPS'nin sağlanmasını sağlama
    • Doğru bağlantı türü
      • Yerel dosyalar için dosya bağlantıları
      • Docset dışındaki dosyalar için URL bağlantıları
    • URL'lerden yerel ayarları kaldırma
    • URL'leri learn.microsoft.com işaret ederken basitleştirin
  • Tüm sürümlerde sürümlenmiş içeriğin doğru olduğunu doğrulama

Dal Birleştirme İşlemi

main dal, ile livebirleştirilmesi gereken tek daldır. Kısa ömürlü (çalışan) dallardaki birleştirmeler, main ile birleştirilmeden önce squash edilmeli.

'den/'ye birleştir release-branch ana yaşamak
çalışma dalı squash ve birleştirme squash ve birleştirme İzin verilmiyor
release-branch birleşmek İzin verilmiyor
ana temel tekrar düzenleme birleşmek

PR Birleştirme denetim listesi

  • İçerik gözden geçirme tamamlandı
  • Değişiklik için doğru hedef dal
  • Birleştirme çakışmaları yok
  • Tüm doğrulama ve derleme adımları başarıyla geçti
  • Tabloya göre birleştirme

Notlar

Aşağıdaki uyarılar göz ardı edilebilir.

Can't find service name for `<version>/<modulepath>/About/About.md`
Metadata with following name(s) are not allowed to be set in YAML header, or as file level
metadata in docfx.json, or as global metadata in docfx.json: `locale`. They are generated by
Docs platform, so the values set in these 3 places will be ignored. Please remove them from all
3 places to resolve the warning.

Çekme isteği birleştirildiğinde, hedef dalın HEAD'i değiştirilir. Önceki HEAD'i temel alan tüm açık PR'ler artık eskidir. Bakımcı, birleştirme uyarılarını geçersiz kılmak ve GitHub'da eski PR'yi birleştirmek için gerekli haklara sahiptir. Önceden birleştirilen PR'ler aynı dosyalara dokunmadıysa, eski bir PR'yi birleştirmek güvenlidir.

Çekme isteğini güncelleştirmek için Branch'i Güncelle düğmesini seçin. Yeniden temelle güncelleştir seçeneğini belirleyin. Daha fazla bilgi için Çekme isteği dalınızı güncelleştirme bölümüne bakın.

Canlıya Yayınlama

Dalda main biriken değişikliklerin düzenli aralıklarla canlı web sitesinde yayımlanması gerekir.

  • Dal main, her iş günü saat 15:00 PST'de live ile birleştirilir.
  • Önemli bir değişiklikten sonra main dalı live ile birleştirilmelidir.
    • 50 veya daha fazla dosyada yapılan değişiklikler
    • Yayın dalını birleştirdikten sonra
    • Depo veya docset yapılandırmalarında yapılan değişiklikler (docfx.json, OPS yapılandırmaları, derleme betikleri vb.)
    • Yeniden yönlendirme dosyasında yapılan değişiklikler
    • İçindekiler tablosuna yapılan değişiklikler
    • Bir "proje" dalı birleştirildikten sonra (içerik yeniden oluşturma, toplu güncelleştirme vb.)