You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by GitBox <gi...@apache.org> on 2022/02/26 07:58:53 UTC

[GitHub] [incubator-inlong] yimaixinchen opened a new pull request #2745: modify the field javadoc

yimaixinchen opened a new pull request #2745:
URL: https://github.com/apache/incubator-inlong/pull/2745


   ### Title Name: [INLONG-XYZ][component] Title of the pull request
   
   where *XYZ* should be replaced by the actual issue number.
   
   Fixes #<xyz>
   
   ### Motivation
   
   *Explain here the context, and why you're making that change. What is the problem you're trying to solve.*
   
   ### Modifications
   
   *Describe the modifications you've done.*
   
   ### Verifying this change
   
   - [ ] Make sure that the change passes the CI checks.
   
   *(Please pick either of the following options)*
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   *(or)*
   
   This change is already covered by existing tests, such as *(please describe tests)*.
   
   *(or)*
   
   This change added tests and can be verified as follows:
   
   *(example:)*
     - *Added integration tests for end-to-end deployment with large payloads (10MB)*
     - *Extended integration test for recovery after broker failure*
   
   ### Documentation
   
     - Does this pull request introduce a new feature? (yes / no)
     - If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
     - If a feature is not applicable for documentation, explain why?
     - If a feature is not documented yet in this PR, please create a followup issue for adding the documentation
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] yimaixinchen closed pull request #2745: modify the field javadoc

Posted by GitBox <gi...@apache.org>.
yimaixinchen closed pull request #2745:
URL: https://github.com/apache/incubator-inlong/pull/2745


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] gosonzhang commented on pull request #2745: modify the field javadoc

Posted by GitBox <gi...@apache.org>.
gosonzhang commented on pull request #2745:
URL: https://github.com/apache/incubator-inlong/pull/2745#issuecomment-1052132036


   @yimaixinchen, first of all, thanks for your contribution
   
   This is a matter of code style and default conventions. I like to use "//" for variable annotations and /** */ for APIs, the main reason is that most of the variables can be explained in one sentence, while the API has parameters and core logic explanations, at least more lines can explain it clearly; Furthermore if the variables are commented with /** */, it will form a relatively large number of lines of code expansion problem.
   
   So this PR personally thinks it is not suitable for merging


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] dockerzhang commented on pull request #2745: modify the field javadoc

Posted by GitBox <gi...@apache.org>.
dockerzhang commented on pull request #2745:
URL: https://github.com/apache/incubator-inlong/pull/2745#issuecomment-1051831698


   @yimaixinchen please change the commit message with `[INLONG-XYZ][component] Title of the pull request`.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-inlong] yimaixinchen commented on pull request #2745: modify the field javadoc

Posted by GitBox <gi...@apache.org>.
yimaixinchen commented on pull request #2745:
URL: https://github.com/apache/incubator-inlong/pull/2745#issuecomment-1051789784


   #2742


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org