github.com/operator-framework/operator-lifecycle-manager@v0.30.0/.github/PULL_REQUEST_TEMPLATE.md (about)

     1  <!--
     2  
     3  Before making a PR, please read our contributing guidelines https://github.com/operator-framework/operator-lifecycle-manager/blob/master/CONTRIBUTING.md
     4  
     5  Note: Make sure your branch is rebased to the latest upstream master.
     6  
     7  -->
     8  
     9  **Description of the change:**
    10  
    11  **Motivation for the change:**
    12  
    13  **Architectural changes:**
    14  
    15  <!--
    16  If necessary, briefly describe any architectural changes, other options considered, and/or link to any EPs or design docs
    17  -->
    18  
    19  **Testing remarks:**
    20  
    21  <!--
    22  Call out any information around how you've tested the code change that may be useful for reviewers. For instance:
    23   * any edge-cases you have (dis)covered
    24   * how you have reproduced and tested for regressions in bug fixes
    25   * how you've tested for flakes in e2e tests or flake fixes
    26  -->
    27  
    28  **Reviewer Checklist**
    29  - [ ] Implementation matches the proposed design, or proposal is updated to match implementation
    30  - [ ] Sufficient unit test coverage
    31  - [ ] Sufficient end-to-end test coverage
    32  - [ ] Bug fixes are accompanied by regression test(s)
    33  - [ ] e2e tests and flake fixes are accompanied evidence of flake testing, e.g. executing the test 100(0) times
    34  - [ ] tech debt/todo is accompanied by issue link(s) in comments in the surrounding code
    35  - [ ] Tests are comprehensible, e.g. Ginkgo DSL is being used appropriately
    36  - [ ] Docs updated or added to `/doc`
    37  - [ ] Commit messages sensible and descriptive
    38  - [ ] Tests marked as `[FLAKE]` are truly flaky and have an issue
    39  - [ ] Code is properly formatted
    40  
    41  
    42  <!--
    43  
    44  Note: If this PR is fixing an issue make sure to add a note saying:
    45  Closes #<ISSUE_NUMBER>
    46  
    47  -->