Skip to content

Commit

Permalink
Improve PR template (#1335)
Browse files Browse the repository at this point in the history
  • Loading branch information
pamelafox authored Feb 28, 2024
1 parent d307f3e commit ddc6f1b
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 25 deletions.
49 changes: 25 additions & 24 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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. -->
- [ ] 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.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ contact [[email protected]](mailto:[email protected]) 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)

Expand Down

0 comments on commit ddc6f1b

Please sign in to comment.