Skip to content

Commit 70590e9

Browse files
committed
Create pull_request_template.md
1 parent b08b483 commit 70590e9

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

.github/pull_request_template.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Description
2+
3+
> Replace this text with a brief description about **why** this PR is necessary. Be sure to provide context.
4+
5+
## Related issues and/or PRs
6+
7+
> Replace this text with links to any existing issues and/or PRs. Or, write `N/A` if no related issues and/or PRs exist.
8+
9+
## Changes made
10+
11+
> Replace this text with an outline the specific changes made in this pull request in the form of a bulleted list. Include relevant details, such as added features, bug fixes, code refactoring, or improvements.
12+
13+
<h2 id="checklist">Checklist</h2>
14+
15+
The following is a best-effort checklist. If any items in this checklist aren't applicable to this PR, add `N/A` after each item.
16+
17+
### Documentation
18+
19+
- [ ] I have updated the side navigation as necessary.
20+
- [ ] I have updated the documentation to reflect the changes.
21+
- [ ] I have documented or updated any remaining open issues linked to this PR in GitHub, Obsidian, etc.
22+
23+
### Build, deploy, and test
24+
25+
- [ ] I have merged and published any dependent changes in other PRs.
26+
- [ ] I have commented my code, particularly in hard-to-understand areas.
27+
- [ ] I have checked that my changes look as expected on a locally built version of the docs site.
28+
- [ ] My changes generate no new warnings.

0 commit comments

Comments
 (0)