diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5306d0890f..d9bdc9125a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,50 +1,17 @@ - +### Description -## Description +add a description of your changes here... -Closes: #XXXX +### Rationale - +tell us why we need these changes... ---- +### Example -### Author Checklist +add an example CLI or API response... -*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.* +### Changes -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 -- [ ] 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/building-modules) -- [ ] 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 -- [ ] 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 `!` 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) +Notable changes: +* add each change in a bullet point here +* ... \ No newline at end of file