You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@helix.apache.org by GitBox <gi...@apache.org> on 2021/04/15 22:54:12 UTC
[GitHub] [helix] NealSun96 opened a new pull request #1699: Add PR Template Section for Backward Compatibility Breaking Changes
NealSun96 opened a new pull request #1699:
URL: https://github.com/apache/helix/pull/1699
### Description
- [x] Here are some details about my PR, including screenshots of any UI changes:
Updates the PR template to include a section where developers can include changes that break backward compatibility. They are encouraged to include these changes in the commit description so that other developers can be easily aware of them.
This is motivated by the fact that feature branches may not be updated by non-backward-compatible changes applied to the master branch. That could cause incorrect or incomplete logic in the feature branch that becomes erroneous after 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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] jiajunwang merged pull request #1699: Add PR Template Section for Backward Compatibility Breaking Changes
Posted by GitBox <gi...@apache.org>.
jiajunwang merged pull request #1699:
URL: https://github.com/apache/helix/pull/1699
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm commented on a change in pull request #1699: Add PR Template Section for Backward Compatibility Breaking Changes
Posted by GitBox <gi...@apache.org>.
pkuwm commented on a change in pull request #1699:
URL: https://github.com/apache/helix/pull/1699#discussion_r618744867
##########
File path: .github/pull_request_template.md
##########
@@ -21,6 +21,12 @@ Any of the following keywords can be used: close, closes, closed, fix, fixes, fi
(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)
+### Changes that Break Backward Compatibility (Optional)
+
+- My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:
Review comment:
It seems the dot `-` is by default checked. See the below style format sections. But now worry. Minor. I'll get them fixed together.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] NealSun96 commented on a change in pull request #1699: Add PR Template Section for Backward Compatibility Breaking Changes
Posted by GitBox <gi...@apache.org>.
NealSun96 commented on a change in pull request #1699:
URL: https://github.com/apache/helix/pull/1699#discussion_r618721060
##########
File path: .github/pull_request_template.md
##########
@@ -21,6 +21,12 @@ Any of the following keywords can be used: close, closes, closed, fix, fixes, fi
(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)
+### Changes that Break Backward Compatibility (Optional)
+
+- My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:
Review comment:
Sorry for the late response @pkuwm . If we take a look at the Documentation section, it's also optional, and not filling it in means "no documentation"; similarly, not filling this section means "no backward compatibility breaking changes".
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm commented on a change in pull request #1699: Add PR Template Section for Backward Compatibility Breaking Changes
Posted by GitBox <gi...@apache.org>.
pkuwm commented on a change in pull request #1699:
URL: https://github.com/apache/helix/pull/1699#discussion_r614572180
##########
File path: .github/pull_request_template.md
##########
@@ -21,6 +21,12 @@ Any of the following keywords can be used: close, closes, closed, fix, fixes, fi
(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)
+### Changes that Break Backward Compatibility (Optional)
+
+- My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:
Review comment:
There should be a checkbox `[ ]` after `-`. Otherwise, it's gonna be be default "breaking backward compatibility"...
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm commented on a change in pull request #1699: Add PR Template Section for Backward Compatibility Breaking Changes
Posted by GitBox <gi...@apache.org>.
pkuwm commented on a change in pull request #1699:
URL: https://github.com/apache/helix/pull/1699#discussion_r614572180
##########
File path: .github/pull_request_template.md
##########
@@ -21,6 +21,12 @@ Any of the following keywords can be used: close, closes, closed, fix, fixes, fi
(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)
+### Changes that Break Backward Compatibility (Optional)
+
+- My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:
Review comment:
There should be a checkbox `[ ]` after `-`. Otherwise, it's gonna be by default "breaking backward compatibility"...
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] NealSun96 commented on pull request #1699: Add PR Template Section for Backward Compatibility Breaking Changes
Posted by GitBox <gi...@apache.org>.
NealSun96 commented on pull request #1699:
URL: https://github.com/apache/helix/pull/1699#issuecomment-820802496
This PR is ready to be merged, approved by @jiajunwang
Final commit message:
## Add PR Template Section for Backward Compatibility Breaking Changes ##
This PR updates the PR template to include a section where developers can include changes that break backward compatibility.
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org