Meningkatkan deskripsi permintaan pull menggunakan templat

Layanan Azure DevOps | Azure DevOps Server 2022 - Azure DevOps Server 2019

Menulis deskripsi permintaan pull yang baik adalah cara yang bagus untuk membantu peninjau mengetahui apa yang diharapkan saat meninjau kode. Ini juga cara yang bagus untuk membantu melacak hal-hal yang perlu dilakukan untuk setiap perubahan, seperti pengujian, menambahkan pengujian unit, dan memperbarui dokumentasi. Templat permintaan pull dapat membantu pengembang Anda membuat deskripsi permintaan pull hebat yang memenuhi standar organisasi Anda.

Artikel ini memperlihatkan kepada Anda cara memulai templat permintaan pull.

Catatan

Templat permintaan pull dapat memberikan panduan, tetapi hanya saran. Gunakan kebijakan cabang untuk menerapkan praktik terbaik seperti memerlukan permintaan pull untuk cabang utama seperti utama, membutuhkan build yang berhasil, dan memberlakukan peninjau yang diperlukan. Untuk informasi selengkapnya, lihat kebijakan cabang.

Apa itu templat permintaan pull?

Templat permintaan pull adalah file yang berisi teks Markdown yang ditambahkan ke deskripsi permintaan pull Anda saat permintaan pull dibuat.

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 memungkinkan Anda membuat jenis templat permintaan pull berikut:

• Templat permintaan pull default yang secara otomatis diterapkan untuk semua permintaan pull baru di repositori, kecuali ditimpa oleh templat permintaan pull khusus cabang
• Templat permintaan pull khusus cabang yang secara otomatis diterapkan ke permintaan pull yang menargetkan cabang tertentu
• Templat permintaan pull tambahan yang dapat ditambahkan secara opsional oleh pembuat permintaan pull

Jenis templat permintaan pull ditentukan oleh nama file dan lokasi foldernya, seperti yang tercakup dalam bagian berikut. Nama file dan lokasi folder tidak peka huruf besar/kecil, tetapi harus berada di cabang default repositori Anda.

Catatan

Semua file templat permintaan pull harus terletak di cabang default (biasanya utama) dari repositori Anda. Hanya file templat permintaan pull dari cabang default yang digunakan.

Templat permintaan pull default

Templat permintaan pull default secara otomatis diterapkan ke bidang deskripsi saat permintaan pull baru dibuat. Untuk mengonfigurasi repositori Anda dengan templat permintaan pull default, buat file bernama pull_request_template.md atau pull_request_template.txt dan simpan di cabang default repositori Anda di salah satu folder berikut.

• Folder bernama .azuredevops yang terkandung dalam folder akar repositori
• Folder bernama .vsts yang terkandung dalam folder akar repositori
• Folder bernama docs yang terkandung dalam folder akar repositori
• Folder akar repositori

Beberapa lokasi disediakan untuk memberi Anda fleksibilitas di tempat Anda menyimpan templat permintaan pull Anda. Saat permintaan pull dibuat, Azure Repos mencari folder yang ditunjuk dalam urutan yang diberikan, dan menggunakan templat permintaan pull default pertama yang ditemukannya.

Ketika permintaan pull baru dibuat di repositori, kecuali templat permintaan pull khusus cabang berlaku, konten templat permintaan pull default digunakan untuk mengisi bidang deskripsi sebelumnya dalam permintaan pull.

Anda dapat mengedit atau menambahkan ke deskripsi ini dan menambahkan templat permintaan pull tambahan jika diinginkan dengan memilihnya dari menu drop-down Tambahkan templat .

Catatan

Ketika templat permintaan pull khusus default atau cabang diterapkan secara otomatis, templat tersebut menggantikan pesan penerapan standar yang biasanya digunakan untuk deskripsi default. Anda dapat menambahkannya kembali dengan memilih Tambahkan pesan penerapan.

Templat permintaan pull khusus cabang

Templat permintaan pull khusus cabang dapat dikonfigurasi untuk permintaan pull yang menargetkan cabang tertentu. Untuk mengonfigurasi repositori Anda dengan templat permintaan pull khusus cabang, buat file atau .md bernama .txt sesuai cabang Anda. Nama harus cocok dengan tingkat pertama nama cabang, seperti main, , devrelease, atau feature. Setiap templat permintaan pull khusus cabang diterapkan kapan saja permintaan pull menargetkan cabang tersebut atau cabang apa pun yang terkandung di bawahnya. Misalnya templat permintaan pull bernama feature.md akan diterapkan jika permintaan pull menargetkan feature cabang atau cabang apa pun feature/* .

Templat permintaan pull khusus cabang harus disimpan di cabang default repositori Anda menggunakan hierarki folder berikut: pull_request_template/branches/. Folder ini harus didasarkan pada salah satu folder berikut di repositori Anda.

• Folder bernama .azuredevops yang terkandung dalam folder akar repositori
• Folder bernama .vsts yang terkandung dalam folder akar repositori
• Folder bernama docs yang terkandung dalam folder akar repositori
• Folder akar repositori

Misalnya, templat permintaan pull khusus cabang yang harus berlaku untuk semua permintaan pull ke cabang dev akan diberi nama dev.md atau dev.txt dan terletak di salah satu lokasi berikut.

• <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/

Sama seperti templat permintaan pull default, beberapa lokasi disediakan untuk memberi Anda fleksibilitas di mana Anda menyimpan templat permintaan pull khusus cabang. Saat permintaan pull dibuat, Azure Repos mencari folder yang ditunjuk dalam urutan yang diberikan untuk templat permintaan pull khusus cabang, dan menggunakan yang pertama yang ditemukan yang cocok dengan nama cabang. Jika tidak ada templat permintaan pull khusus cabang yang ditemukan, Azure Repos kemudian mencari templat permintaan pull default seperti yang dijelaskan di bagian Templat permintaan pull Default sebelumnya.

Templat permintaan pull tambahan

Selain templat permintaan pull default dan cabang tertentu, Anda dapat mengonfigurasi templat permintaan pull tambahan. Ini bisa berupa .md file atau .txt , yang terletak di salah satu folder berikut di cabang default Anda.

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

Saat permintaan pull dibuat, Anda dapat menambahkan salah satu templat permintaan pull yang tersedia dengan memilihnya dari menu drop-down Tambahkan templat . Nama-nama dalam drop-down didasarkan pada nama file templat.

Dalam contoh berikut, tiga templat dicantumkan.

• dev.md - Ini adalah templat khusus cabang yang diterapkan secara default ke permintaan pull ini ke cabang dev, seperti yang ditunjukkan oleh pesan default yang tercantum setelah nama file.
• additional.md - Ini adalah templat tambahan.
• pull_request_template.md - Ini biasanya templat default tetapi ditimpa oleh dev.md templat khusus cabang dalam permintaan pull ini. Meskipun tidak ditambahkan secara default, itu masih dapat diterapkan dengan memilihnya dari daftar.

Pilih nama templat tambahan yang diinginkan untuk menambahkan kontennya ke deskripsi permintaan pull saat ini.

Catatan

Anda dapat menentukan templat permintaan pull untuk menimpa permintaan pull default atau cabang yang cocok dengan menambahkan ?template=name.md ke querystring.

Lihat juga

• Membuat permintaan pull untuk meninjau dan menggabungkan kode
• Tentang cabang dan kebijakan cabang