Şablonları kullanarak çekme isteği açıklamalarını geliştirme

  • Makale

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

İyi çekme isteği açıklamaları yazmak, gözden geçirenlerin kodu gözden geçirirken ne bekleyebileceğinizi bilmelerine yardımcı olmak için harika bir yoldur. Ayrıca test etme, birim testleri ekleme ve belgeleri güncelleştirme gibi her değişiklik için yapılması gerekenleri izlemenize yardımcı olmak için de harika bir yoldur. Çekme isteği şablonları, geliştiricilerinizin kuruluşunuzun standartlarını karşılayan harika çekme isteği açıklamaları oluşturmalarına yardımcı olabilir.

Bu makalede, çekme isteği şablonlarını kullanmaya başlama adımları gösterilmektedir.

Not

Çekme isteği şablonları rehberlik sağlayabilir, ancak yalnızca danışmanlıktır. Main gibi anahtar dallar için çekme istekleri gerektirme, başarılı bir derleme gerektirme ve gerekli gözden geçirenleri zorlama gibi en iyi yöntemleri uygulamak için dal ilkelerini kullanın. Daha fazla bilgi için bkz. dal ilkeleri.

Çekme isteği şablonu nedir?

Çekme isteği şablonu, çekme isteği oluşturulduğunda çekme isteği açıklamanıza eklenen Markdown metnini içeren bir dosyadır.

Thank you for your contribution to the Fabrikam Fiber repo. 
Before submitting this PR, please make sure:

- [ ] Your code builds clean without any errors or warnings
- [ ] You are using approved terminology
- [ ] You have added unit tests

Azure Repos aşağıdaki çekme isteği şablonları türünü oluşturmanıza olanak tanır:

  • Dala özgü bir çekme isteği şablonu tarafından geçersiz kılınmadığı sürece depodaki tüm yeni çekme istekleri için otomatik olarak uygulanan varsayılan çekme isteği şablonu
  • Belirli bir dalı hedefleyen çekme isteklerine otomatik olarak uygulanan dallara özgü çekme isteği şablonları
  • İsteğe bağlı olarak çekme isteği oluşturucusu tarafından eklenebilen ek çekme isteği şablonları

Çekme isteği şablonunun türü, aşağıdaki bölümlerde ele alınan dosya adı ve klasör konumuna göre belirlenir. Dosya adları ve klasör konumları büyük/küçük harfe duyarlı değildir, ancak deponuzun varsayılan dalında olmalıdır.

Not

Tüm çekme isteği şablon dosyaları, deponuzun varsayılan dalında (genellikle ana) bulunmalıdır. Yalnızca varsayılan daldan çekme isteği şablon dosyaları kullanılır.

Varsayılan çekme isteği şablonları

Varsayılan çekme isteği şablonları, yeni bir çekme isteği oluşturulduğunda açıklama alanına otomatik olarak uygulanır. Deponuzu varsayılan çekme isteği şablonuyla yapılandırmak için veya pull_request_template.txt adlı pull_request_template.md bir dosya oluşturun ve aşağıdaki klasörlerden birinde deponuzun varsayılan dalında kaydedin.

  • Deponun kök klasöründe bulunan adlı .azuredevops klasör
  • Deponun kök klasöründe bulunan adlı .vsts klasör
  • Deponun kök klasöründe bulunan adlı docs klasör
  • Deponun kök klasörü

Çekme isteği şablonlarınızı depoladığınız yerde esneklik sağlamak için birden çok konum sağlanır. Çekme isteği oluşturulduğunda, Azure Repos belirlenen klasörleri verilen sırayla arar ve bulduğu ilk varsayılan çekme isteği şablonunu kullanır.

Depoda yeni bir çekme isteği oluşturulduğunda, dala özgü bir çekme isteği şablonu geçerli olmadığı sürece, çekme isteğindeki açıklama alanını önceden doldurmak için varsayılan çekme isteği şablonunun içeriği kullanılır.

Varsayılan çekme isteği şablonu

Bu açıklamayı düzenleyebilir veya ekleyebilir ve isterseniz Şablon ekle açılan listesinden seçerek ek çekme isteği şablonlarıekleyebilirsiniz .

Not

Varsayılan veya dala özgü bir çekme isteği şablonu otomatik olarak uygulandığında, genellikle varsayılan açıklama için kullanılan standart işleme iletilerinin yerini alır. İşleme iletileri ekle'yi seçerek bunları yeniden ekleyebilirsiniz.

Dallara özgü çekme isteği şablonları

Dallara özgü çekme isteği şablonları, belirli bir dalı hedefleyen çekme istekleri için yapılandırılabilir. Deponuzu dala özgü bir çekme isteği şablonuyla yapılandırmak için dalınızın adını taşıyan bir .txt veya .md dosyası oluşturun. Ad, dal adının , , releaseveya featuregibi maindevilk düzeyiyle eşleşmelidir. Her dala özgü çekme isteği şablonu, bir çekme isteği o dalı veya altında yer alan dalları hedeflediğinden uygulanır. Örneğin, bir çekme isteği dalı veya dalları feature/* hedeflediyse feature adlı feature.md çekme isteği şablonu uygulanır.

Dallara özgü çekme isteği şablonları aşağıdaki klasör hiyerarşisi kullanılarak deponuzun varsayılan dalında kaydedilmelidir: pull_request_template/branches/. Bu klasörler, deponuzda aşağıdaki klasörlerden birinde temel alınmalıdır.

  • Deponun kök klasöründe bulunan adlı .azuredevops klasör
  • Deponun kök klasöründe bulunan adlı .vsts klasör
  • Deponun kök klasöründe bulunan adlı docs klasör
  • Deponun kök klasörü

Örneğin, daldaki dev tüm çekme isteklerine uygulanması gereken dala özgü bir çekme isteği şablonu adlandırılabilir dev.md veya dev.txt aşağıdaki konumlardan birinde bulunur.

  • <repository root>/.azuredevops/pull_request_template/branches/
  • <repository root>/.vsts/pull_request_template/branches/
  • <repository root>/docs/pull_request_template/branches/
  • <repository root>/pull_request_template/branches/

Aynı varsayılan çekme isteği şablonları gibi, dallara özgü çekme isteği şablonlarını depoladığınız yerde esneklik sağlamak için birden çok konum sağlanır. Bir çekme isteği oluşturulduğunda, Azure Repos belirtilen klasörlerde dala özgü bir çekme isteği şablonu için verilen sırayla aramalar ve dal adıyla eşleşen ilk bulduğu klasörü kullanır. Dala özgü çekme isteği şablonu bulunamazsa, Azure Repos önceki Varsayılan çekme isteği şablonları bölümünde açıklandığı gibi varsayılan bir çekme isteği şablonu arar.

Dallara özgü çekme isteği şablonu

Ek çekme isteği şablonları

Varsayılan ve dala özgü çekme isteği şablonlarına ek olarak ek çekme isteği şablonları yapılandırabilirsiniz. Bunlar, varsayılan dalınızın aşağıdaki klasörlerinden birinde bulunan veya .txt dosyaları olabilir.md.

  • <repository root>/.azuredevops/pull_request_template/
  • <repository root>/.vsts/pull_request_template/
  • <repository root>/docs/pull_request_template/
  • <repository root>/pull_request_template/

Çekme isteği oluşturulduğunda, kullanılabilir çekme isteği şablonlarından herhangi birini Şablon ekle açılan listesinden seçerek ekleyebilirsiniz. Açılan listede yer alan adlar, şablonların dosya adlarını temel alır.

Aşağıdaki örnekte üç şablon listelenmiştir.

  • dev.md - Bu, dosya adından sonra listelenen varsayılan iletide gösterildiği gibi, bu çekme isteğine varsayılan olarak dev dala uygulanan dala özgü şablondur.
  • additional.md - Bu ek bir şablondur.
  • pull_request_template.md - Bu normalde varsayılan şablondur ancak bu çekme isteğindeki dev.md dala özgü şablon tarafından geçersiz kılındı. Varsayılan olarak eklenmese de, listeden seçilerek uygulanabilir.

Ek çekme isteği şablonu

İçeriğini geçerli çekme isteği açıklamasına eklemek için istenen ek şablonun adını seçin.

Ek çekme isteği şablonu eklenmiştir

Not

Sorgu dizesine ekleyerek ?template=name.md eşleşen varsayılan veya dallara özgü çekme isteklerini geçersiz kılmak için bir çekme isteği şablonu belirtebilirsiniz.

Ayrıca bkz.