Skip to content

Commit 51ccda4

Browse files
Merge pull request #17 from michaelbabiy/mb/ab#1222434-add-pr-template
Documentation: Created a detailed GitHub pull request template with sections for introduction, motivation, proposed solution, additional info, tests, source compatibility, and reminders
2 parents b279f06 + a988297 commit 51ccda4

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

.github/pull_request_template.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Introduction:
2+
Give a summary of the feature in a one-paragraph "elevator pitch." Please keep it simple and clear so the reader can easily understand the problem this proposal is addressing.
3+
4+
5+
## Motivation:
6+
Outline the issues this PR aims to resolve.
7+
8+
9+
## Proposed Solution:
10+
Explain your solution to the problem. Share examples and show how they work. Compare your fix to what's used now - does it make things easier, safer, or faster?
11+
12+
13+
## Additional Info:
14+
Include test data in this section. Provide relevant examples or details that will be used for testing purposes, ensuring all necessary information is documented here.
15+
16+
17+
## Tests:
18+
Provide a brief description of the unit tests written for business conditions. If no unit tests have been written, explain why.
19+
20+
* List/describe unit tests here.
21+
22+
Provide a brief description of the user testing conducted and whether those tests were performed on a physical device. If no testing was conducted, explain why.
23+
24+
* List testing scenarios here.
25+
26+
27+
## Source Compatibility:
28+
Please check the box to indicate the impact of this proposal on source compatibility.
29+
30+
* [ ] This change is additive and does not impact existing source code.
31+
* [ ] This change breaks existing source code.
32+
33+
34+
## Reminders:
35+
* [ ] Check the branch this PR is against.
36+
* [ ] Add your initials in the PR title: "MB: Add Sentry Mode"
37+
* [ ] Add your initials in the PR branch: "mb/add-sentry-mode"
38+
* [ ] For Reviewers:
39+
* Perform user testing (if applicable).
40+
* Check written tests (if applicable).

0 commit comments

Comments
 (0)