chesnokoff commented on code in PR #13759: URL: https://github.com/apache/ignite/pull/13759#discussion_r4393132243
########## rfcs/IGNITE-29219-public-api-and-compatibility.md: ########## @@ -0,0 +1,77 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Public API, public behavior, and compatibility contracts + +Ticket: [IGNITE-29219](https://issues.apache.org/jira/browse/IGNITE-29219) + +## Public behavior + +A compatible change preserves supported functionality and its guarantees. This applies to external interfaces, stored data, and supported build and deployment setups: + +- **Results and effects:** accepted inputs, guarantees about results, and side effects. +- **Operations:** guarantees about transactions, ordering, retries, and cancellation. +- **Errors:** errors, including error codes and SQLState values. +- **Extensions:** guarantees about calls to overridden methods and callbacks. Review Comment: The document doesn’t mention ignite-extensions. Are they part of the public API? Do we guarantee compatibility between core and extensions? Or do you mean them by "plugins and SPIs"? Also "Extensions" item in "Public behavior" is easy to confuse with ignite-extensions. Maybe rename it to "Extension points"? -- 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]
