Article BC break part 1 #777
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sowbiba
reviewed
Sep 23, 2020
| } | ||
| ``` | ||
|
|
||
| This is possible because the class is not [final](https://www.php.net/manual/en/language.oop5.final.php) so it is open for inheritance. It can be then considered that this class, and all of its protected and public properties and methods, are part of the API interface of this project. This means than any non-backwards compatible change to this class is a Breaking Change. |
There was a problem hiding this comment.
This means that any non-backward compatible change to this class is a Breaking Change
|
Thanks for the proofreading @sowbiba ! |
|
Added some more this evening. I think the size is decent, and the "what about BC breaks in PrestaShop" is somewhere near 200 lines of code so I will keep the articles split in two. To finish this one, I believe I need
|
Co-authored-by: Pablo Borowicz <pablo.borowicz@prestashop.com>
atomiix
reviewed
Dec 17, 2020
|
|
||
| If a project integrates this library as a dependency and wishes to extend this behavior, a very standard way to do so is to use [inheritance](https://en.wikipedia.org/wiki/Inheritance_(object-oriented_programming)). | ||
|
|
||
| For example maybe project A needs a Money object with an identifier ? So it could create its own child class: |
There was a problem hiding this comment.
Suggested change
| For example maybe project A needs a Money object with an identifier ? So it could create its own child class: | |
| For example maybe project A needs a Money object with an identifier? So it could create its own child class: |
|
|
||
| BC breaks are a [hindrance](https://www.snoyman.com/blog/2018/04/stop-breaking-compatibility) for the users of a dependency as they require an upgrade of the code relying on it. So it seems getting rid of them, never introducing BC breaks would be a nice idea, right? | ||
|
|
||
| Unfortunately BC breaks are necessary for software to evolve. Maintaining backward compatibility strongly limits the options of the dependency maintainers and can stand in the way of necessary evolutions. This is why they are needed and why they are introduded in new major releases. |
There was a problem hiding this comment.
Suggested change
| Unfortunately BC breaks are necessary for software to evolve. Maintaining backward compatibility strongly limits the options of the dependency maintainers and can stand in the way of necessary evolutions. This is why they are needed and why they are introduded in new major releases. | |
| Unfortunately BC breaks are necessary for software to evolve. Maintaining backward compatibility strongly limits the options of the dependency maintainers and can stand in the way of necessary evolutions. This is why they are needed and why they are introduced in new major releases. |
|
Closing after 1 year. Not needed anymore. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This article is the 1st part of a big article explaining what exactly are Backward Compatibility Breaks also known as Breaking Changes or BC breaks.
This article
I am not yet sure whether I should append to this part 1 the next part "BC breaks come in many shapes on PrestaShop project, how do we deal with them" or it should be another article.
This is WIP, I need to
Fixes #704 partially