[helix] branch master updated: Add PR Template Section for Backward Compatibility Breaking Changes (#1699)

[ji...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jiajunwang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/helix.git


The following commit(s) were added to refs/heads/master by this push:
     new edb6045  Add PR Template Section for Backward Compatibility Breaking Changes (#1699)
edb6045 is described below

commit edb60451b01c33b8aff0b78ec4d992a513e2c7e1
Author: Neal Sun <ne...@gmail.com>
AuthorDate: Wed May 5 14:41:01 2021 -0700

    Add PR Template Section for Backward Compatibility Breaking Changes (#1699)
    
    This PR updates the PR template to include a section where developers can include changes that break backward compatibility.
    
    Co-authored-by: Neal Sun <ne...@nesun-mn1.linkedin.biz>
---
 .github/pull_request_template.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index f2c3025..1720331 100644
--- a/.github/pull_request_template.md
+++ b/.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:
+
+(Consider including all behavior changes for public methods or API. Also include these changes in merge description so that other developers are aware of these changes. This allows them to make relevant code changes in feature branches accounting for the new method/API behavior.)
+
 ### Documentation (Optional)
 
 - In case of new functionality, my PR adds documentation in the following wiki page: