yuchaoran2011 commented on a change in pull request #61:
URL:
https://github.com/apache/incubator-yunikorn-release/pull/61#discussion_r781765608
##########
File path: docs/release-procedure.md
##########
@@ -74,6 +74,13 @@ Follow these steps to generate the list:
- Select the style `Text` and click `create`
- Scroll to the bottom of the page and copy the content of the text area and
update the [CHANGELOG](../release-top-level-artifacts/CHANGELOG) file.
+## Incompatible Changes
+YuniKorn community puts a high priority to the backwards compatibility. For
each release, all incompatible
+changes must be carefully reviewed and documented. In general, incompatible
changes to the public APIs usually requires
Review comment:
```suggestion
changes must be carefully reviewed and documented. In general, incompatible
changes to the public APIs usually require
```
##########
File path: docs/release-procedure.md
##########
@@ -74,6 +74,13 @@ Follow these steps to generate the list:
- Select the style `Text` and click `create`
- Scroll to the bottom of the page and copy the content of the text area and
update the [CHANGELOG](../release-top-level-artifacts/CHANGELOG) file.
+## Incompatible Changes
+YuniKorn community puts a high priority to the backwards compatibility. For
each release, all incompatible
+changes must be carefully reviewed and documented. In general, incompatible
changes to the public APIs usually requires
+a major version bump, this needs to be discussed in the private list. Examples
are REST API changes, scheduler-interface
Review comment:
```suggestion
a major version bump and they need to be discussed in the private list.
Examples are REST API changes, scheduler-interface
```
##########
File path: docs/release-procedure.md
##########
@@ -74,6 +74,13 @@ Follow these steps to generate the list:
- Select the style `Text` and click `create`
- Scroll to the bottom of the page and copy the content of the text area and
update the [CHANGELOG](../release-top-level-artifacts/CHANGELOG) file.
+## Incompatible Changes
+YuniKorn community puts a high priority to the backwards compatibility. For
each release, all incompatible
Review comment:
```suggestion
YuniKorn community puts a high priority on backward compatibility. For each
release, all incompatible
```
##########
File path: docs/release-procedure.md
##########
@@ -74,6 +74,13 @@ Follow these steps to generate the list:
- Select the style `Text` and click `create`
- Scroll to the bottom of the page and copy the content of the text area and
update the [CHANGELOG](../release-top-level-artifacts/CHANGELOG) file.
+## Incompatible Changes
+YuniKorn community puts a high priority to the backwards compatibility. For
each release, all incompatible
+changes must be carefully reviewed and documented. In general, incompatible
changes to the public APIs usually requires
+a major version bump, this needs to be discussed in the private list. Examples
are REST API changes, scheduler-interface
+main API changes. In the release notes, all incompatible changes must be
clearly documented. User should be able to
Review comment:
```suggestion
main API changes. In the release notes, all incompatible changes must be
clearly documented. Users should be able to
```
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
