github.com/yankunsam/loki/v2@v2.6.3-0.20220817130409-389df5235c27/.github/pull_request_template.md (about)

     1  <!--  Thanks for sending a pull request!  Before submitting:
     2  
     3  1. Read our CONTRIBUTING.md guide
     4  2. Name your PR as `<Feature Area>: Describe your change`.
     5    a. Do not end the title with punctuation. It will be added in the changelog.
     6    b. Start with an imperative verb. Example: Fix the latency between System A and System B.
     7    c. Use sentence case, not title case.
     8    d. Use a complete phrase or sentence. The PR title will appear in a changelog, so help other people understand what your change will be.
     9  3. Rebase your PR if it gets out of sync with main
    10  -->
    11  
    12  **What this PR does / why we need it**:
    13  
    14  **Which issue(s) this PR fixes**:
    15  Fixes #<issue number>
    16  
    17  **Special notes for your reviewer**:
    18  
    19  <!--
    20  Note about CHANGELOG entries, if a change adds:
    21  * an important feature
    22  * fixes an issue present in a previous release, 
    23  * causes a change in operation that would be useful for an operator of Loki to know
    24  then please add a CHANGELOG entry.
    25  
    26  For documentation changes, build changes, simple fixes etc please skip this step. We are attempting to curate a changelog of the most relevant and important changes to be easier to ingest by end users of Loki.
    27  
    28  Note about the upgrade guide, if this changes:
    29  * default configuration values
    30  * metric names or label names
    31  * changes existing log lines such as the metrics.go query output line
    32  * configuration parameters 
    33  * anything to do with any API
    34  * any other change that would require special attention or extra steps to upgrade
    35  Please document clearly what changed AND what needs to be done in the upgrade guide.
    36  -->
    37  **Checklist**
    38  - [ ] Documentation added
    39  - [ ] Tests updated
    40  - [ ] Is this an important fix or new feature? Add an entry in the `CHANGELOG.md`.
    41  - [ ] Changes that require user attention or interaction to upgrade are documented in `docs/sources/upgrading/_index.md`