Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add "Since:" on proto doc comments (backport #10434) #10449

Merged
merged 2 commits into from Oct 29, 2021

Commits on Oct 27, 2021

  1. chore: Add "Since:" on proto doc comments (#10434)

    <!--
    The default pull request template is for types feat, fix, or refactor.
    For other templates, add one of the following parameters to the url:
    - template=docs.md
    - template=other.md
    -->
    
    ## Description
    
    ref: #10406 (reply in thread)
    
    For clients to know whether a protobuf feature is available for a certain SDK version, we decided to use the [`@since` doc comment](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#@since) inside protobuf files.
    
    <!-- Add a description of the changes that this PR introduces and the files that
    are the most critical to review. -->
    
    ---
    
    ### Author Checklist
    
    *All items are required. Please add a note to the item if the item is not applicable and
    please add links to any relevant follow up issues.*
    
    I have...
    
    - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
    - [ ] added `!` to the type prefix if API or client breaking change
    - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
    - [ ] provided a link to the relevant issue or specification
    - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
    - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
    - [ ] added a changelog entry to `CHANGELOG.md`
    - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
    - [ ] updated the relevant documentation or specification
    - [ ] reviewed "Files changed" and left comments if necessary
    - [ ] confirmed all CI checks have passed
    
    ### Reviewers Checklist
    
    *All items are required. Please add a note if the item is not applicable and please add
    your handle next to the items reviewed if you only reviewed selected items.*
    
    I have...
    
    - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
    - [ ] confirmed `!` in the type prefix if API or client breaking change
    - [ ] confirmed all author checklist items have been addressed
    - [ ] reviewed state machine logic
    - [ ] reviewed API design and naming
    - [ ] reviewed documentation is accurate
    - [ ] reviewed tests and test coverage
    - [ ] manually tested (if applicable)
    
    (cherry picked from commit 0a3660d)
    
    # Conflicts:
    #	docs/core/proto-docs.md
    #	proto/cosmos/bank/v1beta1/bank.proto
    #	proto/cosmos/tx/v1beta1/tx.proto
    #	types/tx/tx.pb.go
    #	x/bank/types/bank.pb.go
    amaury1093 authored and mergify-bot committed Oct 27, 2021
    Copy the full SHA
    5786f4f View commit details
    Browse the repository at this point in the history
  2. Fix conflicts

    amaury1093 committed Oct 27, 2021
    Copy the full SHA
    72802b3 View commit details
    Browse the repository at this point in the history