From ca753223025cc59c1395528c874d7e72d792c1bc Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Tue, 20 Dec 2022 09:17:52 +0100 Subject: [PATCH] chore: Add more PR templates --- .github/PULL_REQUEST_TEMPLATE/ci.md | 7 +++++++ .github/PULL_REQUEST_TEMPLATE/doc.md | 1 + .../v4.md} | 11 ++--------- .github/PULL_REQUEST_TEMPLATE/v5.md | 11 +++++++++++ 4 files changed, 21 insertions(+), 9 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/ci.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/doc.md rename .github/{PULL_REQUEST_TEMPLATE.md => PULL_REQUEST_TEMPLATE/v4.md} (60%) create mode 100644 .github/PULL_REQUEST_TEMPLATE/v5.md diff --git a/.github/PULL_REQUEST_TEMPLATE/ci.md b/.github/PULL_REQUEST_TEMPLATE/ci.md new file mode 100644 index 000000000..764933516 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/ci.md @@ -0,0 +1,7 @@ +Fixes + +## PR Checklist +Please convert it to a draft if any of the following conditions are not met. Reviewers may skip over until all the items are checked: + +- [ ] If changed package build ci, pass [this action](https://github.com/emqx/emqx/actions/workflows/build_packages.yaml) (manual trigger) +- [ ] Change log has been added to `changes/` dir for user-facing artifacts update diff --git a/.github/PULL_REQUEST_TEMPLATE/doc.md b/.github/PULL_REQUEST_TEMPLATE/doc.md new file mode 100644 index 000000000..af1c9127f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/doc.md @@ -0,0 +1 @@ +Fixes diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/v4.md similarity index 60% rename from .github/PULL_REQUEST_TEMPLATE.md rename to .github/PULL_REQUEST_TEMPLATE/v4.md index 38c008b04..11b282091 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE/v4.md @@ -1,7 +1,4 @@ - -Fixes - -**If your build fails** due to your commit message not passing the build checks, please review the guidelines here: https://github.com/emqx/emqx/blob/master/CONTRIBUTING.md. +Fixes ## PR Checklist Please convert it to a draft if any of the following conditions are not met. Reviewers may skip over until all the items are checked: @@ -9,11 +6,7 @@ Please convert it to a draft if any of the following conditions are not met. Rev - [ ] Added tests for the changes - [ ] Changed lines covered in coverage report - [ ] Change log has been added to `changes/` dir -- [ ] For EMQX 4.x: `appup` files updated (execute `scripts/update-appup.sh emqx`) +- [ ] `appup` files updated (execute `scripts/update-appup.sh emqx`) - [ ] For internal contributor: there is a jira ticket to track this change - [ ] If there should be document changes, a PR to emqx-docs.git is sent, or a jira ticket is created to follow up - [ ] In case of non-backward compatible changes, reviewer should check this item as a write-off, and add details in **Backward Compatibility** section - -## Backward Compatibility - -## More information diff --git a/.github/PULL_REQUEST_TEMPLATE/v5.md b/.github/PULL_REQUEST_TEMPLATE/v5.md new file mode 100644 index 000000000..a0db01e1a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/v5.md @@ -0,0 +1,11 @@ +Fixes + +## PR Checklist +Please convert it to a draft if any of the following conditions are not met. Reviewers may skip over until all the items are checked: + +- [ ] Added tests for the changes +- [ ] Changed lines covered in coverage report +- [ ] Change log has been added to `changes/` dir +- [ ] For internal contributor: there is a jira ticket to track this change +- [ ] If there should be document changes, a PR to emqx-docs.git is sent, or a jira ticket is created to follow up +- [ ] Schema changes are backward compatible