bosun.org@v0.0.0-20210513094433-e25bc3e69a1f/.github/pull_request_template.md (about)

     1  <!--
     2  ## Please follow the guide below
     3  
     4  - You will be asked some questions, please read them **carefully** and answer honestly
     5  - Put an `x` into all the boxes [ ] relevant to your *pull request* (like that [x])
     6  - Use *Preview* tab to see how your *pull request* will actually look like
     7  -->
     8  
     9  ---
    10  
    11  # Description
    12  
    13  <!--
    14  Please describe your contribution in an issue first, to see if it fits the roadmap of the project. This makes it easier 
    15  for us and you to accept your contribution without requiring too much rework.
    16  Please include a summary of the change and which issue is fixed. 
    17  Please also include relevant motivation and context. 
    18  List any dependencies that are required for this change. 
    19  -->
    20  
    21  Fixes #0000 (fill in)
    22  
    23  ## Type of change
    24  
    25  <!--
    26  From the following, please check the options that are relevant.
    27  -->
    28  
    29  - [ ] Bug fix (non-breaking change which fixes an issue)
    30  - [ ] New feature (non-breaking change which adds functionality)
    31  - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
    32  - [ ] This change requires a documentation update
    33  
    34  # How has this been tested?
    35  
    36  <!--
    37  Please describe the tests that you ran to verify your changes. 
    38  Provide instructions so we can reproduce. 
    39  Please also list any relevant details for your test configuration
    40  -->
    41  
    42  - [ ] Test A
    43  - [ ] Test B
    44  
    45  # Checklist:
    46  
    47  - [ ] This contribution follows the project's [code of conduct](https://github.com/bosun-monitor/bosun/blob/master/CODE_OF_CONDUCT.md)
    48  - [ ] This contribution follows the project's [contributing guidelines](https://github.com/bosun-monitor/bosun/blob/master/CONTRIBUTING.md)
    49  - [ ] My code follows the style guidelines of this project
    50  - [ ] I have performed a self-review of my own code
    51  - [ ] I have commented my code, particularly in hard-to-understand areas
    52  - [ ] I have made corresponding changes to the documentation
    53  - [ ] I have added tests that prove my fix is effective or that my feature works
    54  - [ ] New and existing unit tests pass locally with my changes
    55  - [ ] Any dependent changes have been merged and published in downstream modules