Skip to content

Commit 6a82d59

Browse files
committed
Updated pr template and verification job
1 parent 506d525 commit 6a82d59

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

.github/pull_request_template.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Replace this block with what this PR does and why. Describe what you'd like revi
44
)
55

66
### Jira ticket
7-
_Link to related jira ticket ([Use the smart commits](https://support.atlassian.com/bitbucket-cloud/docs/use-smart-commits/))_
7+
_Link to related jira ticket ([Use the smart commits](https://support.atlassian.com/bitbucket-cloud/docs/use-smart-commits/)). Short version (e.g. DOTS-123) also works and gets auto-linked_
88

99
### Changelog
1010
[//]: # (updated with all public facing changes - API changes, UI/UX changes, behaviour changes, bug fixes. Remove if not relevant.)
1111

1212
- Added: The package whose Changelog should be added to should be in the header. Delete the changelog section entirely if it's not needed.
1313
- Fixed: If you update multiple packages, create a new section with a new header for the other package.
14-
- Removed/Deprecated/Changed: Each bullet should be prefixed with Added, Fixed, Removed, Deprecated, or Changed to indicate where the entry should go
14+
- Removed/Deprecated/Changed: Each bullet should be prefixed with Added, Fixed, Removed, Deprecated, or Changed to indicate where the entry should go.
1515

1616
<!-- Uncomment and mark items off with a * if this PR deprecates any API:
1717
### Deprecated API
@@ -31,12 +31,14 @@ We should always evaluate if the changes in this PR require any documentation ch
3131
- Includes documentation for previously-undocumented public API entry points.
3232
- Includes edits to existing public API documentation.
3333

34-
## Testing & QA
34+
## Testing & QA (How your changes can be verified during release Playtest)
3535
[//]: # (
3636
This section is REQUIRED and should describe how the changes were tested and how should they be tested when Playtesting for the release.
3737
It can range from "edge case covered by unit tests" to "manual testing required and new sample was added".
3838
Expectation is that PR creator does some manual testing and provides a summary of it here.)
3939

40+
<!-- Add any performance testing results here if relevant. -->
41+
4042
### Functional Testing
4143
[//]: # (If checked, List manual tests that have been performed.)
4244
_Manual testing :_
@@ -51,11 +53,11 @@ _Does the change require QA team to:_
5153
- [ ] `Review automated tests`?
5254
- [ ] `Execute manual tests`?
5355

54-
If any boxes above are checked, please add QA as a PR reviewer.
56+
If any boxes above are checked the QA team will be automatically added as a PR reviewer.
5557

56-
## Backport
58+
## Backports
5759
[//]: # (
5860
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
5961
Add the following to the PR title: "\[Backport\] ..."
6062
If this is not needed, for example feature specific to NGOv2.X, then just mention this fact.
61-
)
63+
)

.github/workflows/pr-verification.yml

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# This workflow is designed to verify that the pull request description contains a required sections that are important from quality perspective.
1+
# This workflow is designed to verify that the pull request description contains a required sections that are important from quality perspective.
22
# ## Backport section is important as a reminder to account for backports for anyone that works with NGO repository (to 1.X or 2.X branches respectively).
33
# ## Testing & QA section is important to ensure that the PR has appropriate testing coverage and is important when QA will evaluate PRs before Playtesting for the release.
44
# ## Documentation section is important to ensure that the documentation is updated with the changes made in the PR.
@@ -18,7 +18,7 @@ on:
1818

1919
jobs:
2020
pr-verification:
21-
runs-on: ubuntu-latest
21+
runs-on: unity-linux-runner
2222
steps:
2323
- name: Checkout code
2424
uses: actions/checkout@v5
@@ -33,16 +33,20 @@ jobs:
3333
// List of mandatory PR sections
3434
const requiredSections = [
3535
{
36-
header: '## Backport',
37-
description: 'PR description must include a "## Backport" section. Please add this section and provide information about this PR backport to develop or develop-2.0.0 branch respectively or explain why backport is not needed.'
36+
header: '## Backports',
37+
description: 'PR description must include a "## Backports" section. Please add this section and provide information about this PR backport to develop or develop-2.0.0 branch respectively or explain why backport is not needed.'
3838
},
3939
{
40-
header: '## Testing & QA',
41-
description: 'PR description must include a "## Testing & QA" section. Please add this section and provide information about the testing performed for this PR. It can range from adding unit tests to full samples and is needed from QA side to analyze PRs while Playtesting for the release.'
40+
header: '## Testing & QA (How your changes can be verified during release Playtest)',
41+
description: 'PR description must include a "## Testing & QA (How your changes can be verified during release Playtest)" section. Please add this section and provide information about the testing performed for this PR. It can range from adding unit tests to full samples and is needed from QA side to analyze PRs while Playtesting for the release.'
4242
},
4343
{
4444
header: '## Documentation',
4545
description: 'PR description must include a "## Documentation" section. Please add this section and provide information about the documentation changes made in this PR. It is important to keep the documentation up to date with the code changes.'
46+
},
47+
{
48+
header: '## Jira ticket',
49+
description: 'PR description must include a "## Jira ticket" section. Please add this section and provide a link to the Jira ticket that corresponds to this PR. General rule should be that if the PR takes you more then a day of work it should have Jira ticket. Otherwise you can always write "N/A" in this section.'
4650
}
4751
];
4852
@@ -59,4 +63,4 @@ jobs:
5963
message += '\n\nPlease add them to your PR description.';
6064
6165
core.setFailed(message);
62-
}
66+
}

0 commit comments

Comments
 (0)