Friday, January 24, 2025

How to create Pull Request (PR) templates in Azure Repos? | Creating pull request template in Azure Repos


Azure Repos allows you to create Pull Request (PR) templates to standardize and streamline the PR process for your team. This ensures that all necessary information is included, making the review process more efficient. 

Step-by-Step Guide

  1. Navigate to Your Repository:

    • Go to the Azure Repos repository where you want to create a PR template.
  2. Create a .azuredevops Directory:

    • create a new directory named .azuredevops in the root of your repository. This is where Azure Repos looks for configuration files, including PR templates.
  3. Create a PULL_REQUEST_TEMPLATE File:

    • Inside the .azuredevops directory, create a file named PULL_REQUEST_TEMPLATE.md. This file will contain the template for your pull requests.

      4. Add Template Content:

  • Open the PULL_REQUEST_TEMPLATE.md file and add the content you want to include in your PR template. You can use Markdown to format the template. Here’s an example of a basic PR template:

## What type of PR is this? (check all applicable)
- [ ] πŸ• New Feature
- [ ] 🎨 Enhancment Feature
- [ ] πŸ› Bug
## Describe about your code changes
<!-- 
Please do not leave this blank 
This PR [adds/removes/fixes/replaces] the [feature/bug/etc]. 
-->
## Related Feature & Documents
<!-- 
Please use this format link issue numbers: Fixes #123
-->
## Screenshots/Recordings Link In Sharepoint
<!-- Visual changes require screenshots -->

## Created Unit tests, etc?
- [ ] πŸ‘ yes
- [ ] πŸ™… no, because they aren't needed
- [ ] πŸ™‹ no, because I need help
## Added to documentation?
- [ ] πŸ“œ README.md
- [ ] πŸ“• wiki
- [ ] πŸ™… no documentation needed
## [optional] Are there any post-deployment tasks we need to perform?

    5. Commit and Push:

  • Commit the PULL_REQUEST_TEMPLATE.md file to your repository and push it to Azure Repo.

git add .azuredevops/PULL_REQUEST_TEMPLATE.md 
git commit -m "Add pull request template" 
git push origin main


No comments:

Post a Comment

How to create Pull Request (PR) templates in Azure Repos? | Creating pull request template in Azure Repos

Azure Repos allows you to create Pull Request (PR) templates to standardize and streamline the PR process for your team. This ensures that a...