From 079e122b8f37bf7aa190a0ea74b419f865096848 Mon Sep 17 00:00:00 2001 From: Marko Date: Tue, 28 Nov 2023 15:17:54 +0100 Subject: [PATCH] chore: remove extra pr template (#18579) --- .github/PULL_REQUEST_TEMPLATE.md | 31 +++++++------------------ .github/PULL_REQUEST_TEMPLATE/docs.md | 32 +++++++++++++------------- .github/PULL_REQUEST_TEMPLATE/other.md | 32 -------------------------- 3 files changed, 24 insertions(+), 71 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/other.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b0f7990b7a9c..b1a5d17daae3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,4 @@ - - -## Description +# Description Closes: #XXXX @@ -14,7 +7,7 @@ are the most critical to review. --> --- -### Author Checklist +## Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* @@ -22,19 +15,16 @@ please add links to any relevant follow up issues.* I have... * [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title -* [ ] added `!` to the type prefix if API or client breaking change +* [ ] confirmed `!` in the type prefix if API or client breaking change * [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) * [ ] provided a link to the relevant issue or specification -* [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/build/building-modules/01-intro.md) +* [ ] reviewed "Files changed" and left comments if necessary * [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing) * [ ] added a changelog entry to `CHANGELOG.md` -* [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) -* [ ] updated the relevant documentation or specification -* [ ] reviewed "Files changed" and left comments if necessary -* [ ] run `make lint` and `make test` +* [ ] updated the relevant documentation or specification, including comments for [documenting Go code](https://blog.golang.org/godoc) * [ ] confirmed all CI checks have passed -### Reviewers Checklist +## Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* @@ -42,10 +32,5 @@ your handle next to the items reviewed if you only reviewed selected items.* I have... * [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title -* [ ] confirmed `!` in the type prefix if API or client breaking change -* [ ] confirmed all author checklist items have been addressed -* [ ] reviewed state machine logic -* [ ] reviewed API design and naming -* [ ] reviewed documentation is accurate -* [ ] reviewed tests and test coverage -* [ ] manually tested (if applicable) +* [ ] confirmed all author checklist items have been addressed +* [ ] reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage diff --git a/.github/PULL_REQUEST_TEMPLATE/docs.md b/.github/PULL_REQUEST_TEMPLATE/docs.md index a5955a5833a6..5f3dadd70066 100644 --- a/.github/PULL_REQUEST_TEMPLATE/docs.md +++ b/.github/PULL_REQUEST_TEMPLATE/docs.md @@ -1,4 +1,4 @@ -## Description +# Description Closes: #XXXX @@ -8,31 +8,31 @@ are the most critical to review. --> --- -### Author Checklist +## Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... -- [ ] included the correct `docs:` prefix in the PR title -- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) -- [ ] provided a link to the relevant issue or specification -- [ ] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/main/docs/DOC_WRITING_GUIDELINES.md) -- [ ] reviewed "Files changed" and left comments if necessary -- [ ] confirmed all CI checks have passed +* [ ] included the correct `docs:` prefix in the PR title +* [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) +* [ ] provided a link to the relevant issue or specification +* [ ] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/main/docs/DOC_WRITING_GUIDELINES.md) +* [ ] reviewed "Files changed" and left comments if necessary +* [ ] confirmed all CI checks have passed -### Reviewers Checklist +## Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... -- [ ] confirmed the correct `docs:` prefix in the PR title -- [ ] confirmed all author checklist items have been addressed -- [ ] confirmed that this PR only changes documentation -- [ ] reviewed content for consistency -- [ ] reviewed content for thoroughness -- [ ] reviewed content for spelling and grammar -- [ ] tested instructions (if applicable) +* [ ] confirmed the correct `docs:` prefix in the PR title +* [ ] confirmed all author checklist items have been addressed +* [ ] confirmed that this PR only changes documentation +* [ ] reviewed content for consistency +* [ ] reviewed content for thoroughness +* [ ] reviewed content for spelling and grammar +* [ ] tested instructions (if applicable) diff --git a/.github/PULL_REQUEST_TEMPLATE/other.md b/.github/PULL_REQUEST_TEMPLATE/other.md deleted file mode 100644 index b4f19151b34e..000000000000 --- a/.github/PULL_REQUEST_TEMPLATE/other.md +++ /dev/null @@ -1,32 +0,0 @@ -## Description - -Closes: #XXXX - - - ---- - -### Author Checklist - -*All items are required. Please add a note to the item if the item is not applicable and -please add links to any relevant follow up issues.* - -I have... - -- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title -- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) -- [ ] provided a link to the relevant issue or specification -- [ ] reviewed "Files changed" and left comments if necessary -- [ ] confirmed all CI checks have passed - -### Reviewers Checklist - -*All items are required. Please add a note if the item is not applicable and please add -your handle next to the items reviewed if you only reviewed selected items.* - -I have... - -- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title -- [ ] confirmed all author checklist items have been addressed -- [ ] confirmed that this PR does not change production code