github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/.github/pull_request_template.md (about)

     1  <!--
     2  Thank you for contributing to TiFlow! 
     3  Please read MD's [CONTRIBUTING](https://github.com/pingcap/tiflow/blob/master/CONTRIBUTING.md) document **BEFORE** filing this PR.
     4  -->
     5  
     6  ### What problem does this PR solve?
     7  <!--
     8  Please create an issue first to describe the problem.
     9  
    10  There MUST be one line starting with "Issue Number:  " and 
    11  linking the relevant issues via the "close" or "ref".
    12  
    13  For more info, check https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/contribute-code.html#referring-to-an-issue.
    14   -->
    15  
    16  Issue Number: close #xxx
    17  
    18  ### What is changed and how it works?
    19  
    20  
    21  ### Check List <!--REMOVE the items that are not applicable-->
    22  
    23  #### Tests <!-- At least one of them must be included. -->
    24  
    25   - Unit test
    26   - Integration test
    27   - Manual test (add detailed scripts or steps below)
    28   - No code
    29  
    30  #### Questions <!-- Authors should answer these questions and reviewers should consider these questions. -->
    31  
    32  ##### Will it cause performance regression or break compatibility?
    33  
    34  ##### Do you need to update user documentation, design documentation or monitoring documentation?
    35  
    36  ### Release note <!-- bugfixes or new features need a release note -->
    37  
    38  ```release-note
    39  Please refer to [Release Notes Language Style Guide](https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/release-notes-style-guide.html) to write a quality release note.
    40  
    41  If you don't think this PR needs a release note then fill it with `None`.
    42  ```