Çekme isteği açıklamalarını şablonlar kullanarak geliştirin.

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

İyi pull request açıklamaları yazmak, gözden geçirenlerin kodu gözden geçirirken ne bekleyeceklerini bilmelerine yardımcı olmak için harika bir yoldur. Ayrıca test etme, birim testi ekleme ve belgeleri güncelleştirme gibi her değişiklik için yapılması gerekenleri izlemeye yardımcı olmak için de harika bir yoldur. Çekme isteği şablonları, geliştiricilerinizin kuruluşunuzun standartlarına uygun 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.

Uyarı

Çekme isteği şablonları rehberlik sağlayabilir, ancak yalnızca öneri niteliğindedir. Ana dal gibi önemli dallar için pull requestler gerektirme, başarılı bir derlemenin tamamlanmasını şart koşma ve gerekli gözden geçirenlerin olması gibi en iyi uygulamaları hayata geçirmek için dal ilkelerini kullanın. Daha fazla bilgi için bkz. dal ilkeleri.

Önkoşullar

Kategori	Gereksinimler
Proje erişimi	projesiüyesi.
İzinler	- Özel projelerde kodu görüntüleme: En az Temel erişimi. - Özel projelerde kodu klonlama veya katkıda bulunma: Projede Katkıda Bulunanlar güvenlik grubuna üyelik veya ilgili izinler. - Dal veya depo izinlerini ayarlayın: izinleri yönetin dal veya depo için. - Varsayılan dalı değiştir: Depo için politika düzenleme izinleri. - Depoyu içeri aktarma: Proje Yöneticileri güvenlik grubunun üyesi veya Git proje düzeyi Depo oluşturma izni İzin verolarak ayarlanmıştır. Daha fazla bilgi için bkz . Git deposu izinlerini ayarlama.
Hizmetler	Repo'lar etkinleştirildi.
Araçlar	Opsiyonel. az repos komutlarını kullanın: Azure DevOps CLI.

Uyarı

Genel projelerde, Paydaş erişimi olan kullanıcılar, kod görüntüleme, kopyalama ve koda katkıda bulunma dahil olmak üzere Azure Depolarına tam erişime sahiptir.

Ç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:

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

Çekme isteği şablonunun türü, aşağıdaki bölümlerde açıklandığı gibi 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.

Uyarı

Tüm çekme isteği şablon dosyaları, deponuzun varsayılan dalında (genellikle ana) bulunmalıdır. Varsayılan daldan yalnızca ç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 pull_request_template.md veya pull_request_template.txt adlı bir dosya oluşturun ve aşağıdaki klasörlerden birinde deponuzun varsayılan dalında kaydedin.

• Deponun kök klasöründe yer alan .azuredevops adlı bir klasör
• Deponun kök klasöründe yer alan .vsts adlı bir klasör
• Deponun kök klasöründe yer alan docs adlı bir 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 belirtilen 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 değilse, çekme isteğindeki açıklama alanını önceden doldurmak için varsayılan çekme isteği şablonunun içeriği kullanılır.

Bu açıklamayı düzenleyebilir veya güncelleyebilir ve isterseniz ek çekme isteği şablonlarını sonuna eklemek için Şablon ekle açılır menüsünden seçebilirsiniz.

Uyarı

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

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

Dala ö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 ilk düzeyiyle eşleşmelidir; örneğin, main, dev, releaseveya feature. Belirli bir dala özgü çekme isteği şablonu, çekme isteği o dalı veya altında yer alan dalları hedeflediğinde her zaman uygulanır. Örneğin, bir çekme isteği feature.md dalını veya herhangi bir feature dalını hedeflediyse feature/* adlı çekme isteği şablonu uygulanır.

Dala özgü çekme talebi ş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 yer alan .azuredevops adlı bir klasör
• Deponun kök klasöründe yer alan .vsts adlı bir klasör
• Deponun kök klasöründe yer alan docs adlı bir klasör
• Deponun kök klasörü

Örneğin, dev daldaki tüm çekme isteklerine uygulanması gereken dala özgü bir çekme isteği şablonu, dev.md veya dev.txt olarak adlandırılır ve 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ında olduğu gibi, dallara özgü çekme isteği şablonlarını 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 dala özgü bir çekme isteği şablonu için verilen sırayla arar ve dal adıyla eşleşen ilk klasörü kullanır. Dalla ilgili çekme isteği şablonu bulunamazsa Azure Repos, önceki Varsayılan çekme isteği şablonları bölümünde açıklandığı gibi varsayılan çekme isteği şablonunu arar.

İlave pull request ş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 .md veya .txt dosyaları olabilir.

• <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 iletisinde belirtildiği gibi, geliştirme dalındaki bu çekme isteğine varsayılan olarak uygulanan dala özgü bir şablondur.
• additional.md - Bu ek bir şablondur.
• pull_request_template.md - Bu normalde varsayılan şablondur, ancak bu çekme talebindeki dev.md dalına özgü şablon tarafından geçersiz kılındı. Varsayılan olarak eklenmese de, listeden seçilerek uygulanabilir.

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

Uyarı

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

Ayrıca bkz.

• Kodu gözden geçirmek ve birleştirmek için çekme isteği (pull request) oluşturma
• Dallar ve dal ilkeleri hakkında