dubbo.apache.org/dubbo-go/v3@v3.1.1/CONTRIBUTING.md (about)

     1  # Contributing
     2  
     3  ## Branch
     4  
     5  Our default branch is `main`, which receives new features and bugfixes. Release
     6  branches, e.g. `release-3.0`, will not received new features but bugfixes.
     7  Opening a pull request for the release branches is what we called "backport".
     8  
     9  ## Title
    10  
    11  The format of the title of PRs should be:
    12  
    13  ```
    14  <type>: One line summary of the PR
    15  ```
    16  
    17  The types are including(https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/):
    18  
    19  - feat: a new feature is introduced with the changes
    20  - fix: a bug fix has occurred
    21  - chore: changes that do not relate to a fix or feature and don't modify src or test files (for example updating dependencies)
    22  - refactor: refactored code that neither fixes a bug nor adds a feature
    23  - docs: updates to documentation such as a the README or other markdown files
    24  - style: changes that do not affect the meaning of the code, likely related to code formatting such as white-space, missing semi-- - colons, and so on.
    25  - test: including new or correcting previous tests
    26  - perf: performance improvements
    27  - ci: continuous integration related
    28  - build: changes that affect the build system or external dependencies
    29  - revert: reverts a previous commit
    30  
    31  If this PR is to backport to other branchs, e.g. `3.0`, then the title would be:
    32  
    33  ```
    34  [3.0] <type>: One line summary of the PR
    35  ```
    36  
    37  ## Commit message
    38  
    39  Each pull request **MUST** have a corresponding issue to explain what does this PR do. The format of message should be:
    40  
    41  ```
    42  (A brief description about this PR.) Lorem ipsum dolor sit amet, consectetur
    43  adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna
    44  aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi
    45  ut aliquip ex ea commodo consequat.
    46  
    47  Fixes: #1000
    48  
    49  Signed-off-by: Example <example@example.com>
    50  ```
    51  
    52  The signed-off message will be appended automaticaly if the developers commit
    53  with `-s` option, for example, `git commit -s`.