You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/git/pull-request-template.md
+16-25Lines changed: 16 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,61 +3,52 @@ id: pull-request-template
3
3
title: Pull Request Template
4
4
---
5
5
6
-
7
6
# Generic Pull Request Template
8
7
9
-
Add a file called pull_request_template.md to the root directory of your repository
8
+
Add a file called `pull_request_template.md` to the root directory of your repository. Take a look at number of ways you can do this in GitHub. https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
10
9
11
10
## Title
11
+
12
12
Provide a general summary of your changes in the title.
13
13
14
14
## Description
15
15
16
-
Describe your changes in detail
16
+
Describe your changes in detail. Link to the related issue ticket.
17
17
18
-
## Motivation, context and link to the ticket
18
+
## Context
19
19
20
20
Why is this change required? What problem does it solve?
21
-
Link to the related Jira ticket.
21
+
22
22
23
23
## Related PRs
24
+
24
25
Link to related pull requests
25
26
26
27
## How has this been tested?
27
-
Please describe in detail how you tested your changes.
28
28
29
-
Include details of your testing environment, and the tests you ran to
29
+
Please describe in detail how you tested your changes. Include details of your testing environment, and the tests you ran.
30
30
31
-
See how your change affects other areas of the code, etc.
32
-
33
-
## Screenshots (if appropriate):
31
+
## Screenshots:
34
32
33
+
Add screenshots or video if applicable.
35
34
36
35
## Types of changes
36
+
37
37
What types of changes does your code introduce? Put an x in all the boxes that apply:
38
38
39
39
[] Bug fix (non-breaking change which fixes an issue)
40
-
41
40
[] New feature (non-breaking change which adds functionality)
42
-
43
41
[] Breaking change (fix or feature that would cause existing functionality to change)
44
-
45
-
[]Documentation Update (if none of the other choices apply)
42
+
[] Documentation
43
+
[]Tests
46
44
47
45
## Checklist
48
-
Go over all the following points, and put an x in all the boxes that apply.
49
-
If you're unsure about any of these, don't hesitate to ask. Your team members are there to help!
50
46
51
-
[] My code follows the code style of this project.
47
+
Go over all the following points, and put an x in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. Your team members are there to help!
52
48
49
+
[] My code follows the code style of this project.
53
50
[] I have updated the documentation accordingly.
54
-
55
51
[] I have added tests to cover my changes.
56
-
57
-
[] All new and existing tests passed.
58
-
59
52
[] One or more required reviews requested.
60
-
61
-
[] Any dependent changes have been merged and published in downstream modules
62
-
63
-
[] I have updated and verified the database schema changes and related documentation have been updated.
53
+
[] Any dependent changes have been merged and published in upstream modules.
54
+
[] I have updated and verified the changes end-to-end and related documentation have been updated.
0 commit comments