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

Azure Repos | Azure DevOps Server 2020 | Azure DevOps Server 2019

İyi çekme isteği açıklamalarını yazmak, kod gözden geçirmede nelerin beklendiğini öğrenmede size yardımcı olmak için harika bir yoldur. Ayrıca, test, birim testleri ekleme ve belge güncelleştirme gibi her değişiklik için yapılması gereken işlemleri izlemeye yardımcı olmak için harika bir yoldur. Çekme isteği şablonları, geliştiricilerin kuruluşunuzun standartlarını karşılayan harika çekme isteği açıklamaları oluşturmalarına yardımcı olabilir.

Bu makalede, çekme isteği şablonlarıyla çalışmaya başlama işlemi gösterilmektedir.

Çekme isteği şablonu nedir?

Çekme isteği şablonu, çekme isteği oluşturulduğunda çekme isteğiniz açıklamasına eklenen markı 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 sağlar:

• Bir dala özgü çekme isteği şablonu tarafından geçersiz kılınmadıkça depodaki tüm yeni çekme istekleri için otomatik olarak uygulanan varsayılan bir çekme isteği şablonu
• 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 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 konumuyla belirlenir. Dosya adları ve klasör konumları büyük/küçük harfe duyarlı değildir, ancak deponun varsayılan dalında olmaları gerekir.

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 bir çekme isteği şablonuyla yapılandırmak için, veya adlı bir dosya oluşturun pull_request_template.mdpull_request_template.txt ve deponuzu varsayılan dalına aşağıdaki klasörlerden birine kaydedin.

• .azuredevopsDeponun kök klasöründe yer alan adlı bir klasör
• .vstsDeponun kök klasöründe yer alan adlı bir klasör
• docsDeponun kök klasöründe yer alan adlı bir klasör
• Deponun kök klasörü

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

Depoda yeni bir çekme isteği oluşturulduğunda, dala özgü çekme isteği şablonu uygulanmamışsa, varsayılan çekme isteği şablonunun içeriği çekme isteğindeki Açıklama alanını önceden doldurmak için kullanılır.

Bu açıklamaya düzenleyebilir veya ekleyebilir ve Şablon Ekle açılır listesinden seçerek ek çekme isteği şablonları ekleyebilirsiniz.

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

Dala özgü çekme isteği şablonları, belirli bir dalı hedefleyen çekme istekleri için yapılandırılabilir. Bir dala özgü çekme isteği şablonuyla deponuzu yapılandırmak için .txt.md dalınızdan sonra adlı bir veya dosya oluşturun. Ad,,, veya gibi dal adının ilk düzeyiyle eşleşmelidir masterdevreleasefeature . Her dala özgü çekme isteği şablonu, bir çekme isteğinin bu dalı veya altında yer alan herhangi bir dalı hedeflediği her seferinde uygulanır. Örneğin, feature.md bir çekme isteği feature dalı veya dalları hedeflediyse adlı çekme isteği şablonu uygulanır feature/* .

Dala özgü çekme isteği şablonları aşağıdaki klasör hiyerarşisi kullanılarak deponuzun varsayılan dalına kaydedilmelidir: pull_request_template/branches/ . Bu klasörler, deponuzdaki aşağıdaki klasörlerden birini temel almalıdır.

• .azuredevopsDeponun kök klasöründe yer alan adlı bir klasör
• .vstsDeponun kök klasöründe yer alan adlı bir klasör
• docsDeponun kök klasöründe yer alan adlı bir klasör
• Deponun kök klasörü

Örneğin, dala tüm çekme istekleri için uygulanması gereken dala özgü çekme isteği şablonu, devdev.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/

Varsayılan çekme isteği şablonlarına benzer şekilde, dala özgü çekme isteği şablonlarının depolanacağı esnekliği sağlamak için birden çok konum sağlanır. bir çekme isteği oluşturulduğunda Azure Repos, dala özgü bir çekme isteği şablonu için belirtilen klasörleri arar ve şube adıyla eşleşen bulduğu ilk olanı kullanır. dala özgü çekme isteği şablonu bulunmazsa, Azure Repos önceki varsayılan çekme isteği şablonları bölümünde açıklandığı gibi varsayılan bir çekme isteği şablonu arar.

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 .md.txt , varsayılan dalınızdaki aşağıdaki klasörlerden birinde bulunan veya dosya olabilir.

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

Bir çekme isteği oluşturulduğunda, bir şablon Ekle açılır listesinden seçerek kullanılabilir çekme isteği şablonlarından herhangi birini ekleyebilirsiniz. Açılan dosyadaki adlar şablonların dosya adlarına göre yapılır.

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

• dev.md -Bu, varsayılan olarak dosya adından sonra listelenen dev.md iletiyle gösterildiği gibi, bu çekme isteğine varsayılan olarak uygulanan dala özgü şablondur.
• additional.md -Bu, ek bir şablondur.
• pull_request_template.md -Bu normalde varsayılan şablondur, ancak dev.md Bu çekme isteğindeki dala ö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 istediğiniz ek şablonun adını seçin.