github.com/m3db/m3@v1.5.0/.github/pull_request_template.md (about)

     1  <!--  Thanks for sending a pull request!  Here are some tips for you:
     2  1. If this is your first time, please read our contributor guidelines: https://github.com/m3db/m3/blob/master/CONTRIBUTING.md and developer notes https://github.com/m3db/m3/blob/master/DEVELOPMENT.md
     3  2. Please prefix the name of the pull request with the component you are updating in the format "[component] Change title" (for example "[dbnode] Support out of order writes") and also label this pull request according to what type of issue you are addressing. Furthermore, if this is a WIP or DRAFT PR, please create a draft PR instead: https://github.blog/2019-02-14-introducing-draft-pull-requests/
     4  3. Ensure you have added or ran the appropriate tests for your PR: read more at https://github.com/m3db/m3/blob/master/DEVELOPMENT.md#testing-changes
     5  4. Follow the instructions for writing a changelog note: read more at https://github.com/m3db/m3/blob/master/DEVELOPMENT.md#updating-the-changelog
     6  -->
     7  
     8  **What this PR does / why we need it**:
     9  <!--
    10  If you have an issue this change addresses, please add the following details:
    11  *Automatically closes linked issue when PR is merged.
    12  Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
    13  -->
    14  Fixes #
    15  
    16  **Special notes for your reviewer**:
    17  
    18  **Does this PR introduce a user-facing and/or backwards incompatible change?**:
    19  <!--
    20  If no, just write "NONE" in the release-note block below.
    21  If yes, a release note is required:
    22  Enter your extended release note in the block below. If the PR requires additional action from users switching to the new release, include the string "action required".
    23  -->
    24  ```release-note
    25  
    26  ```
    27  
    28  **Does this PR require updating code package or user-facing documentation?**:
    29  <!--
    30  If no, just write "NONE" in the documentation-note block below.
    31  If yes, describe which documentation you updated.
    32  Note: Any changes that significantly updates how a code package is architectured or functions requires code package documentation updates in the form of updates to the README.md file in that package.
    33  -->
    34  ```documentation-note
    35  
    36  ```