github.com/cosmos/cosmos-sdk@v0.50.10/.github/PULL_REQUEST_TEMPLATE.md (about)

     1  <!--
     2  The default pull request template is for types feat, fix, or refactor.
     3  For other templates, add one of the following parameters to the url:
     4  - template=docs.md
     5  - template=other.md
     6  -->
     7  
     8  ## Description
     9  
    10  Closes: #XXXX
    11  
    12  <!-- Add a description of the changes that this PR introduces and the files that
    13  are the most critical to review. -->
    14  
    15  ---
    16  
    17  ### Author Checklist
    18  
    19  *All items are required. Please add a note to the item if the item is not applicable and
    20  please add links to any relevant follow up issues.*
    21  
    22  I have...
    23  
    24  * [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
    25  * [ ] added `!` to the type prefix if API or client breaking change
    26  * [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
    27  * [ ] provided a link to the relevant issue or specification
    28  * [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules)
    29  * [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
    30  * [ ] added a changelog entry to `CHANGELOG.md`
    31  * [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
    32  * [ ] updated the relevant documentation or specification
    33  * [ ] reviewed "Files changed" and left comments if necessary
    34  * [ ] run `make lint` and `make test`
    35  * [ ] confirmed all CI checks have passed
    36  
    37  ### Reviewers Checklist
    38  
    39  *All items are required. Please add a note if the item is not applicable and please add
    40  your handle next to the items reviewed if you only reviewed selected items.*
    41  
    42  I have...
    43  
    44  * [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
    45  * [ ] confirmed `!` in the type prefix if API or client breaking change
    46  * [ ] confirmed all author checklist items have been addressed 
    47  * [ ] reviewed state machine logic
    48  * [ ] reviewed API design and naming
    49  * [ ] reviewed documentation is accurate
    50  * [ ] reviewed tests and test coverage
    51  * [ ] manually tested (if applicable)