---
title: "Pull Request Template"
source: Microsoft Code-With Engineering Playbook
source_url: https://github.com/microsoft/code-with-engineering-playbook
licence: CC-BY-4.0
domain: engineering
subdomain: microsoft-code-with-playbook
date_added: 2026-04-25
---

# Pull Request Template

```markdown
# [Work Item ID](./link-to-the-work-item)

For more information about how to contribute to this repo, visit this [page](https://github.com/microsoft/code-with-engineering-playbook/blob/main/CONTRIBUTING.md)

## Description

---

> Should include a concise description of the changes (bug or feature), it's impact, along with a summary of the solution

## Steps to Reproduce Bug and Validate Solution

---
> Only applicable if the work is to address a bug. Please remove this section if the work is for a feature or story
> Provide details on the environment the bug is found, and detailed steps to recreate the bug.
> This should be detailed enough for a team member to confirm that the bug no longer occurs

## PR Checklist

---

> Use the check-list below to ensure your branch is ready for PR.  If the item is not applicable, leave it blank.

- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
- [ ] My code follows the code style of this project.
- [ ] I ran the lint checks which produced no new errors nor warnings for my changes.
- [ ] I have checked to ensure there aren't other open Pull Requests for the same update/change.

## Does This Introduce a Breaking Change?

---

- [ ] Yes
- [ ] No

> If this introduces a breaking change, please describe the impact and migration path for existing applications below.

## Testing

---

> - Instructions for testing and validation of your code:
>   - What OS was used for testing.
>   - Which test sets were used.
>   - Description of test scenarios that you have tried.

## Any Relevant Logs or Outputs

---

> - Use this section to attach pictures that demonstrates your changes working / healthy
> - If you are printing something show a screenshot
> - When you want to share long logs upload to:
>  `(StorageAccount)/pr-support/attachments/(PR Number)/(yourFiles) using [Azure Storage Explorer](https://azure.microsoft.com/en-us/features/storage-explorer/)` or [portal.azure.com](https://portal.azure.com) and insert the link here.

## Other Information or Known Dependencies

---

> - Any other information or known dependencies that is important to this PR.
> - TODO that are to be done after this PR.
```
