github.com/maypok86/otter@v1.2.1/.github/pull_request_template.md (about)

     1  ## Description
     2  
     3  <!--
     4  Describes the nature of your changes. If they are substantial, you should
     5  further subdivide this into a section describing the problem you are solving and
     6  another describing your solution.
     7  -->
     8  
     9  ## Related issue(s)
    10  
    11  <!--
    12  - Short description of how the PR relates to the issue, including an issue link.
    13  For example
    14  - Fixed #100500 by adding lenses to exported items
    15  
    16  Write 'None' if there are no related issues (which is discouraged).
    17  -->
    18  
    19  ## :white_check_mark: Checklist for your Pull Request
    20  
    21  <!--
    22  Ideally a PR has all of the checkmarks set.
    23  
    24  If something in this list is irrelevant to your PR, you should still set this
    25  checkmark indicating that you are sure it is dealt with (be that by irrelevance).
    26  
    27  If you don't set a checkmark (e. g. don't add a test for new functionality),
    28  you must be able to justify that.
    29  -->
    30  
    31  #### Related changes (conditional)
    32  
    33  - Tests
    34      - [ ] If I added new functionality, I added tests covering it.
    35      - [ ] If I fixed a bug, I added a regression test to prevent the bug from
    36        silently reappearing again.
    37  
    38  - Documentation
    39      - [ ] I checked whether I should update the docs and did so if necessary:
    40          - [README](../README.md)
    41  
    42  - Public contracts
    43      - [ ] My changes doesn't break project license.
    44  
    45  #### Stylistic guide (mandatory)
    46  
    47  - [ ] My code complies with the [styles guide](https://github.com/uber-go/guide/blob/master/style.md).
    48  - [ ] My commit history is clean (only contains changes relating to my
    49    issue/pull request and no reverted-my-earlier-commit changes) and commit
    50    messages start with identifiers of related issues in square brackets.
    51  
    52    **Example:** `[#42] Short commit description`
    53  
    54    If necessary both of these can be achieved even after the commits have been
    55    made/pushed using [rebase and squash](https://git-scm.com/docs/git-rebase).
    56  
    57  #### Before merging (mandatory)
    58  - [ ] Check __target__  branch of PR is set correctly