Skip to content

Commit f7fdd05

Browse files
committed
Updated PR template after visually checking
1 parent f2e17f5 commit f7fdd05

File tree

1 file changed

+19
-25
lines changed

1 file changed

+19
-25
lines changed

.github/pull_request_template.md

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
## Purpose of this PR
2-
[//]: # (Describe the purpose of the PR)
3-
<!-- Replace this block with what this PR does and why. Describe what you'd like reviewers to know, how you applied the engineering principles, and any interesting tradeoffs made. Delete bullet points below that don't apply, and update the changelog section as appropriate. -->
2+
[//]: # (
3+
Replace this block with what this PR does and why. Describe what you'd like reviewers to know, how you applied the engineering principles, and any interesting tradeoffs made.
4+
)
45

56
### Jira ticket
67
_Link to related jira ticket ([Use the smart commits](https://support.atlassian.com/bitbucket-cloud/docs/use-smart-commits/))_
@@ -9,10 +10,10 @@ _Link to related jira ticket ([Use the smart commits](https://support.atlassian.
910
[//]: # (updated with all public facing changes - API changes, UI/UX changes, behaviour changes, bug fixes. Remove if not relevant.)
1011

1112
- Added: The package whose Changelog should be added to should be in the header. Delete the changelog section entirely if it's not needed.
12-
- Fixed: If you update multiple packages, create a new section with a new header for the other package.
13+
- Fixed: If you update multiple packages, create a new section with a new header for the other package.
1314
- Removed/Deprecated/Changed: Each bullet should be prefixed with Added, Fixed, Removed, Deprecated, or Changed to indicate where the entry should go.
1415
- Documentation: Contains significant docs changes
15-
-
16+
1617
<!-- Uncomment and mark items off with a * if this PR deprecates any API:
1718
### Deprecated API
1819
- [ ] An `[Obsolete]` attribute was added along with a `(RemovedAfter yyyy-mm-dd)` entry.
@@ -22,21 +23,21 @@ _Link to related jira ticket ([Use the smart commits](https://support.atlassian.
2223
-->
2324

2425
### Documentation
25-
<!--
26-
This section is REQUIRED and should mention what documentation changes were following the changes in this PR.
27-
We should always evaluate if the changes in this PR require any documentation changes.
28-
-->
26+
[//]: # (
27+
This section is REQUIRED and should mention what documentation changes were following the changes in this PR.
28+
We should always evaluate if the changes in this PR require any documentation changes.
29+
)
2930

3031
- No documentation changes or additions were necessary.
3132
- Includes documentation for previously-undocumented public API entry points.
3233
- Includes edits to existing public API documentation.
3334

3435
## Testing & QA
35-
<!--
36-
This section is REQUIRED and should describe how the changes were tested and how should they be tested when Playtesting for the release.
37-
It can range from "edge case covered by unit tests" to "manual testing required and new sample was added".
38-
Expectation is that PR creator does some manual testing and provides a summary of it here.
39-
-->
36+
[//]: # (
37+
This section is REQUIRED and should describe how the changes were tested and how should they be tested when Playtesting for the release.
38+
It can range from "edge case covered by unit tests" to "manual testing required and new sample was added".
39+
Expectation is that PR creator does some manual testing and provides a summary of it here.)
40+
4041
### Functional Testing
4142
[//]: # (If checked, List manual tests that have been performed.)
4243
_Manual testing :_
@@ -54,15 +55,8 @@ _Does the change require QA team to:_
5455
If any boxes above are checked, please add QA as a PR reviewer.
5556

5657
## Backport
57-
<!--
58-
This section is REQUIRED and should preferably link to the PR that targets other NGO version (develop, develop-2.0.0 branches)
59-
If this is not needed (for example feature specific to NGOv2.X) then just mention this fact.
60-
-->
61-
62-
<!-- If this is a backport:
63-
- Add the following to the PR title: "\[Backport\] ..." .
64-
- Link to the original PR.
65-
If this needs a backport - state this here
66-
If a backport is not needed please provide the reason why.
67-
If the "Backports" section is not present it will lead to a CI test failure.
68-
-->
58+
[//]: # (
59+
This section is REQUIRED and should link to the PR that targets other NGO version which is either develop or develop-2.0.0 branch
60+
Add the following to the PR title: "\[Backport\] ..."
61+
If this is not needed, for example feature specific to NGOv2.X, then just mention this fact.
62+
)

0 commit comments

Comments
 (0)