Skip to content

Commit 2658444

Browse files
committed
Add PR template
1 parent 84110d9 commit 2658444

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!-- 🚨 Please Do Not skip any instructions and information mentioned below as they are all required and essential to evaluate and test the PR. By fulfilling all the required information you will be able to reduce the volume of questions and most likely help merge the PR faster 🚨 -->
2+
3+
<!-- ⚠️ We will not merge the PR to the main repo if your changes are not in a *feature branch* of your forked repository. Create a new branch in your repo, **do not use the `main` branch in your repo**! -->
4+
5+
<!-- ⚠️ **Every PR** needs to have a linked issue and have previously been approved. PRs that don't follow this will be rejected. >
6+
7+
<!-- 👉 It is imperative to resolve ONE ISSUE PER PR and avoid making multiple changes unless the changes interrelate with each other -->
8+
9+
<!-- 📝 Please always keep the "☑️ Allow edits by maintainers" button checked in the Pull Request Template as it increases collaboration with the Toolkit maintainers by permitting commits to your PR branch (only) created from your fork. This can let us quickly make fixes for minor typos or forgotten StyleCop issues during review without needing to wait on you doing extra work. Let us help you help us! 🎉 -->
10+
11+
**Closes #<ISSUE_NUMBER>**
12+
13+
<!-- Add an overview of the changes here -->
14+
15+
<!-- All details should be in the linked issue. Feel free to call out any outstanding differences here. -->
16+
17+
## PR Checklist
18+
19+
<!-- Please check if your PR fulfills the following requirements, and remove the ones that are not applicable to the current PR -->
20+
21+
- [ ] Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
22+
- [ ] Based off latest main branch of toolkit
23+
- [ ] PR doesn't include merge commits (always rebase on top of our main, if needed)
24+
- [ ] Tested code with current [supported SDKs](../#supported)
25+
- [ ] New component
26+
- [ ] Pull Request has been submitted to the documentation repository [instructions](../blob/main/Contributing.md#docs). Link: <!-- docs PR link -->
27+
- [ ] Added description of major feature to project description for NuGet package (4000 total character limit, so don't push entire description over that)
28+
- [ ] Tests for the changes have been added (for bug fixes / features) (if applicable)
29+
- [ ] Header has been added to all new source files (run _build/UpdateHeaders.bat_)
30+
- [ ] Contains **NO** breaking changes
31+
- [ ] Every new API (including internal ones) has full XML docs
32+
- [ ] Code follows all style conventions
33+
34+
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below.
35+
Please note that breaking changes are likely to be rejected within minor release cycles or held until major versions. -->
36+
37+
## Other information
38+
39+
<!-- Please add any other information that might be helpful to reviewers. -->

0 commit comments

Comments
 (0)