chore: update pull request templates (#9342)
* add new templates * add revised checklists * draft reviews checklist * update checklists * update checklists * minor revisions * delete old template * apply review suggestion * set default template Co-authored-by: ryanchrypto <12519942+ryanchrypto@users.noreply.github.com>
This commit is contained in:
parent
f1ec0e2193
commit
d14398f849
|
@ -1,29 +1,50 @@
|
|||
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
|
||||
v ✰ Thanks for creating a PR! ✰
|
||||
v Before smashing the submit button please review the checkboxes.
|
||||
v If a checkbox is n/a - please still include it but + a little note why
|
||||
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->
|
||||
<!--
|
||||
The default pull request template is for types feat, fix, or refactor.
|
||||
For other templates, add one of the following parameters to the url:
|
||||
- template=docs.md
|
||||
- template=other.md
|
||||
-->
|
||||
|
||||
## Description
|
||||
|
||||
<!-- Add a description of the changes that this PR introduces and the files that
|
||||
are the most critical to review.
|
||||
-->
|
||||
Closes: #XXXX
|
||||
|
||||
closes: #XXXX
|
||||
<!-- Add a description of the changes that this PR introduces and the files that
|
||||
are the most critical to review. -->
|
||||
|
||||
---
|
||||
|
||||
Before we can merge this PR, please make sure that all the following items have been
|
||||
checked off. If any of the checklist items are not applicable, please leave them but
|
||||
write a little note why.
|
||||
### Author Checklist
|
||||
|
||||
- [ ] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
|
||||
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
|
||||
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md).
|
||||
- [ ] Wrote unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
|
||||
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
|
||||
- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code).
|
||||
- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
|
||||
- [ ] Re-reviewed `Files changed` in the Github PR explorer
|
||||
- [ ] Review `Codecov Report` in the comment section below once CI passes
|
||||
*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
|
||||
- [ ] 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/master/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/master/docs/building-modules)
|
||||
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/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)
|
|
@ -0,0 +1,37 @@
|
|||
## Description
|
||||
|
||||
Closes: #XXXX
|
||||
|
||||
<!-- Add a description of the changes that this PR introduces and the files that
|
||||
are the most critical to review. -->
|
||||
|
||||
---
|
||||
|
||||
### 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/master/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/master/docs/DOC_WRITING_GUIDELINES.md)
|
||||
- [ ] 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 `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)
|
|
@ -0,0 +1,32 @@
|
|||
## Description
|
||||
|
||||
Closes: #XXXX
|
||||
|
||||
<!-- Add a description of the changes that this PR introduces and the files that
|
||||
are the most critical to review. -->
|
||||
|
||||
---
|
||||
|
||||
### 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/master/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
|
Loading…
Reference in New Issue