github.com/cloudwego/iasm@v0.2.0/.github/PULL_REQUEST_TEMPLATE.md (about)

     1  #### What type of PR is this?
     2  <!--
     3  Add one of the following kinds:
     4  
     5  build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
     6  ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
     7  docs: Documentation only changes
     8  feat: A new feature
     9  optimize: A new optimization
    10  fix: A bug fix
    11  perf: A code change that improves performance
    12  refactor: A code change that neither fixes a bug nor adds a feature
    13  style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc)
    14  test: Adding missing tests or correcting existing tests
    15  chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
    16  -->
    17  
    18  #### Check the PR title.
    19  <!--
    20  The description of the title will be attached in Release Notes, 
    21  so please describe it from user-oriented, what this PR does / why we need it.
    22  Please check your PR title with the below requirements:
    23  -->
    24  - [ ] This PR title match the format: \<type\>(optional scope): \<description\>
    25  - [ ] The description of this PR title is user-oriented and clear enough for others to understand.
    26  - [ ] Attach the PR updating the user documentation if the current PR requires user awareness at the usage level. [User docs repo](https://github.com/cloudwego/cloudwego.github.io)
    27  
    28  
    29  #### (Optional) Translate the PR title into Chinese.
    30  
    31  
    32  #### (Optional) More detailed description for this PR(en: English/zh: Chinese).
    33  <!--
    34  Provide more detailed info for review(e.g., it's recommended to provide perf data if this is a perf type PR).
    35  -->
    36  en:
    37  zh(optional): 
    38  
    39  
    40  #### (Optional) Which issue(s) this PR fixes:
    41  <!--
    42  Automatically closes linked issue when PR is merged.
    43  Eg: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
    44  -->
    45  
    46  #### (optional) The PR that updates user documentation:
    47  <!--
    48  If the current PR requires user awareness at the usage level, please submit a PR to update user docs. [User docs repo](https://github.com/cloudwego/cloudwego.github.io)
    49  -->