Skip to content

Commit 61f93a6

Browse files
authored
Align PR template (#187)
1 parent 500597f commit 61f93a6

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+23-14
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,33 @@
1-
<!-- Reminder: Keep READMEs up to date -->
1+
<!--- Provide a general summary of your changes in the title. -->
22

3-
Ticket(s): BT-###, FE-###,...
3+
### Description
4+
<!--- Describe your changes in detail. -->
45

5-
## Problem
6+
### Motivation and context
7+
<!--- Why is this change required? What problem does it solve? -->
8+
<!--- If it fixes an open issue, link to the issue. -->
69

7-
Explain the context and why you're making that change. What is the problem you're trying to solve? In some cases there is not a problem and this can be thought of being the motivation for your change.
10+
### How was the change tested?
11+
<!--- Describe how you tested your changes. -->
12+
<!--- Include details of your testing environment, tests you ran to -->
13+
<!--- see how your change affects other areas of the code, etc. -->
814

9-
## Solution
15+
### Screenshots (if appropriate):
1016

11-
Describe the modifications you've done.
12-
13-
## Result
14-
15-
What will change as a result of your pull request? Note that sometimes this section is unnecessary because it is self-explanatory based on the solution.
16-
17-
## Testing
18-
19-
Describe the manual and automated tests you completed to verify the change is working as expected.
17+
### Change types
18+
<!--- What types of changes does your code introduce? Put an `x` in any boxes that apply: -->
19+
* - [ ] Bug fix (non-breaking change that fixes an issue)
20+
* - [ ] New feature (non-breaking change that adds functionality)
21+
* - [ ] Breaking change (backwards-incompatible fix or feature)
2022

23+
### Checklist:
24+
<!--- Review the following points. Put an `x` in any boxes that apply. -->
25+
<!--- If you're unsure, don't hesitate to ask. We're here to help! -->
26+
* - [ ] My code follows the code style of this project.
27+
* - [ ] My change requires a change to Fauna documentation.
28+
* - [ ] My change requires a change to the README, and I have updated it accordingly.
2129

2230
----
2331
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
2432

33+

0 commit comments

Comments
 (0)