Skip to content

Commit ddc6f1b

Browse files
authored
Improve PR template (#1335)
1 parent d307f3e commit ddc6f1b

File tree

2 files changed

+26
-25
lines changed

2 files changed

+26
-25
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,31 @@
11
## Purpose
2+
23
<!-- Describe the intention of the changes being proposed. What problem does it solve or functionality does it add? -->
3-
* ...
4+
45

56
## Does this introduce a breaking change?
6-
<!-- Mark one with an "x". -->
7+
8+
When developers merge from main and run the server, azd up, or azd deploy, will this produce an error?
9+
If you're not sure, try it out on an old environment.
10+
711
```
812
[ ] Yes
913
[ ] No
1014
```
1115

12-
## Pull Request Type
13-
What kind of change does this Pull Request introduce?
16+
## Does this require changes to learn.microsoft.com docs?
17+
18+
This repository is referenced by [this tutorial](https://learn.microsoft.com/azure/developer/python/get-started-app-chat-template)
19+
which includes deployment, settings and usage instructions. If text or screenshot need to change in the tutorial,
20+
check the box below and notify the tutorial author. A Microsoft employee can do this for you if you're an external contributor.
21+
22+
```
23+
[ ] Yes
24+
[ ] No
25+
```
26+
27+
## Type of change
1428

15-
<!-- Please check the one that applies to this PR using "x". -->
1629
```
1730
[ ] Bugfix
1831
[ ] Feature
@@ -22,24 +35,12 @@ What kind of change does this Pull Request introduce?
2235
[ ] Other... Please describe:
2336
```
2437

25-
## How to Test
26-
* Get the code
27-
28-
```
29-
git clone [repo-address]
30-
cd [repo-name]
31-
git checkout [branch-name]
32-
npm install
33-
```
34-
35-
* Test the code
36-
<!-- Add steps to run the tests suite and/or manually test -->
37-
```
38-
```
38+
## Code quality checklist
3939

40-
## What to Check
41-
Verify that the following are valid
42-
* ...
40+
See [CONTRIBUTING.md](../CONTRIBUTING.md#submit-pr) for more details.
4341

44-
## Other Information
45-
<!-- Add any other helpful information that may be needed here. -->
42+
- [ ] The current tests all pass (`python -m pytest`).
43+
- [ ] I added tests that prove my fix is effective or that my feature works
44+
- [ ] I ran `python -m pytest --cov` to verify 100% coverage of added lines
45+
- [ ] I ran `python -m mypy` to check for type errors
46+
- [ ] I either used the pre-commit hooks or ran `ruff` and `black` manually on my code.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ contact [[email protected]](mailto:[email protected]) with any additio
1515
- [Code of Conduct](#coc)
1616
- [Issues and Bugs](#issue)
1717
- [Feature Requests](#feature)
18-
- [Submission Guidelines](#submit)
18+
- [Submitting a PR](#submit-pr)
1919
- [Running Tests](#tests)
2020
- [Code Style](#style)
2121

0 commit comments

Comments
 (0)