Skip to content

Commit 3b7a24f

Browse files
committed
PR verification comments update
1 parent 4cb6c80 commit 3b7a24f

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

.github/workflows/pr-verification.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# This workflow is designed to verify that the pull request description contains a "## Backport" section, which is important as a reminder to account for backports for anyone that works with NGO repository.
2-
# We have 2 development branches (develop and develop-2.0.0) and we need to ensure that relevant changes are landing in only one or both of them
3-
# If the "##Backport" section is missing, the workflow will fail and block the PR from merging, prompting the developer to add this section.
1+
# This workflow is designed to verify that the pull request description contains a required sections that are important from quality perspective.
2+
# ## 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).
3+
# ## 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.
4+
# ### Documentation section is important to ensure that the documentation is updated with the changes made in the PR.
45

6+
# If any of the sections is missing, the workflow will fail and block the PR from merging, prompting the developer to add those sections to the PR description.
57
# The workflow is configured to run when PR is created as well as when it is edited which also counts simple description edits.
68

7-
name: "NGO - Backport Verification"
9+
name: "NGO - PR Verification"
810

911
on:
1012
pull_request:

0 commit comments

Comments
 (0)