From ddc6f1bafb426df82b1a0143283a10ea3c411265 Mon Sep 17 00:00:00 2001
From: Pamela Fox <pamelafox@microsoft.com>
Date: Wed, 28 Feb 2024 12:03:58 -0800
Subject: [PATCH] Improve PR template (#1335)

---
 .github/PULL_REQUEST_TEMPLATE.md | 49 ++++++++++++++++----------------
 CONTRIBUTING.md                  |  2 +-
 2 files changed, 26 insertions(+), 25 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index ab05e292b7..8fbf5ee8f8 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,18 +1,31 @@
 ## Purpose
+
 <!-- Describe the intention of the changes being proposed. What problem does it solve or functionality does it add? -->
-* ...
+
 
 ## Does this introduce a breaking change?
-<!-- Mark one with an "x". -->
+
+When developers merge from main and run the server, azd up, or azd deploy, will this produce an error?
+If you're not sure, try it out on an old environment.
+
 ```
 [ ] Yes
 [ ] No
 ```
 
-## Pull Request Type
-What kind of change does this Pull Request introduce?
+## Does this require changes to learn.microsoft.com docs?
+
+This repository is referenced by [this tutorial](https://learn.microsoft.com/azure/developer/python/get-started-app-chat-template)
+which includes deployment, settings and usage instructions. If text or screenshot need to change in the tutorial,
+check the box below and notify the tutorial author. A Microsoft employee can do this for you if you're an external contributor.
+
+```
+[ ] Yes
+[ ] No
+```
+
+## Type of change
 
-<!-- Please check the one that applies to this PR using "x". -->
 ```
 [ ] Bugfix
 [ ] Feature
@@ -22,24 +35,12 @@ What kind of change does this Pull Request introduce?
 [ ] Other... Please describe:
 ```
 
-## How to Test
-*  Get the code
-
-```
-git clone [repo-address]
-cd [repo-name]
-git checkout [branch-name]
-npm install
-```
-
-* Test the code
-<!-- Add steps to run the tests suite and/or manually test -->
-```
-```
+## Code quality checklist
 
-## What to Check
-Verify that the following are valid
-* ...
+See [CONTRIBUTING.md](../CONTRIBUTING.md#submit-pr) for more details.
 
-## Other Information
-<!-- Add any other helpful information that may be needed here. -->
\ No newline at end of file
+- [ ] The current tests all pass (`python -m pytest`).
+- [ ] I added tests that prove my fix is effective or that my feature works
+- [ ] I ran `python -m pytest --cov` to verify 100% coverage of added lines
+- [ ] I ran `python -m mypy` to check for type errors
+- [ ] I either used the pre-commit hooks or ran `ruff` and `black` manually on my code.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fc3bd43581..6a8f67c5dc 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
  - [Code of Conduct](#coc)
  - [Issues and Bugs](#issue)
  - [Feature Requests](#feature)
- - [Submission Guidelines](#submit)
+ - [Submitting a PR](#submit-pr)
  - [Running Tests](#tests)
  - [Code Style](#style)