Skip to content

Commit 6137c94

Browse files
committed
PR template update
1 parent d8fabf5 commit 6137c94

File tree

1 file changed

+46
-20
lines changed

1 file changed

+46
-20
lines changed

.github/pull_request_template.md

Lines changed: 46 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
1-
<!-- 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. -->
1+
## Purpose of this PR
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+
)
25

3-
<!-- Add short version of the JIRA ticket to the PR title (e.g. "feat: new shiny feature [MTT-123]") -->
6+
### Jira ticket
7+
_Link to related jira ticket ([Use the smart commits](https://support.atlassian.com/bitbucket-cloud/docs/use-smart-commits/))_
48

5-
## Changelog
9+
### Changelog
10+
[//]: # (updated with all public facing changes - API changes, UI/UX changes, behaviour changes, bug fixes. Remove if not relevant.)
611

712
- Added: The package whose Changelog should be added to should be in the header. Delete the changelog section entirely if it's not needed.
813
- Fixed: If you update multiple packages, create a new section with a new header for the other package.
914
- Removed/Deprecated/Changed: Each bullet should be prefixed with Added, Fixed, Removed, Deprecated, or Changed to indicate where the entry should go.
10-
11-
## Testing and Documentation
12-
13-
- No tests have been added.
14-
- Includes unit tests.
15-
- Includes integration tests.
16-
- No documentation changes or additions were necessary.
17-
- Includes documentation for previously-undocumented public API entry points.
18-
- Includes edits to existing public API documentation.
15+
- Documentation: Contains significant docs changes
1916

2017
<!-- Uncomment and mark items off with a * if this PR deprecates any API:
2118
### Deprecated API
@@ -25,12 +22,41 @@
2522
- [ ] The users can understand why this API was removed and what they should use instead.
2623
-->
2724

28-
## Backport
25+
### Documentation
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

30-
<!-- If this is a backport:
31-
- Add the following to the PR title: "\[Backport\] ..." .
32-
- Link to the original PR.
33-
If this needs a backport - state this here
34-
If a backport is not needed please provide the reason why.
35-
If the "Backports" section is not present it will lead to a CI test failure.
36-
-->
31+
- No documentation changes or additions were necessary.
32+
- Includes documentation for previously-undocumented public API entry points.
33+
- Includes edits to existing public API documentation.
34+
35+
## Testing & QA
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+
41+
### Functional Testing
42+
[//]: # (If checked, List manual tests that have been performed.)
43+
_Manual testing :_
44+
- [ ] `Manual testing done`
45+
46+
_Automated tests:_
47+
- [ ] `Covered by existing automated tests`
48+
- [ ] `Covered by new automated tests`
49+
50+
_Does the change require QA team to:_
51+
52+
- [ ] `Review automated tests`?
53+
- [ ] `Execute manual tests`?
54+
55+
If any boxes above are checked, please add QA as a PR reviewer.
56+
57+
## Backport
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)