docs: add info about breaking changes to contributing guide #854
Conversation
I extended the CONTRIBUTING.md file with content for Breaking Change vs Non Breaking Change.
Dule-martins
requested review from
fmvilas,
derberg,
dalelane,
smoya,
char0n and
asyncapi-bot-eve
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
Dule-martins
changed the title
|
Thanks a 💯 @Dule-martins please modify:
|
CONTRIBUTING.md
Outdated
| _Non-breaking changes:_ | ||
| - Adding a property | ||
|
|
||
| _Breaking changes:_ | ||
| - Making a property required | ||
| - Making a property optional | ||
| - Removing a property | ||
| - Changing the type of a property in any way |
There was a problem hiding this comment.
Is it intended to be an exhaustive list or just an example?
There was a problem hiding this comment.
from the suggestion made I think it is a list, I can't be sure of how exhaustive it is nor if it is an example.
Maybe @derberg could explain that.
There was a problem hiding this comment.
it is intended as a result of #688
it should be explicit
Dule-martins
changed the title
Co-authored-by: Fran Méndez <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
CONTRIBUTING.md
Outdated
| Specifications are not much different than software. Some changes provided in the spec can cause breaking changes for tools that support it. For example, if one of the properties that was `required` becomes `optional`, it is considered a breaking change because some tools might depend on that property and fail if all suddenly it is not provided. | ||
|
|
||
| _Non-breaking changes:_ | ||
| - Adding a property |
There was a problem hiding this comment.
should this be adding an optional property?
There was a problem hiding this comment.
Yes, definitely. If you add a required property, it's a breaking change.
There was a problem hiding this comment.
@dalelane makes sense, can you make a code change suggestion for @Dule-martins please?
There was a problem hiding this comment.
@derberg I just committed all suggestions made here.
|
This pull request has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation. There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
Co-authored-by: Dale Lane <[email protected]>
Co-authored-by: Dale Lane <[email protected]>
Co-authored-by: Vladimír Gorej <[email protected]>
|
we need to specify something super important about discussed scenario:
expected result:
current result:
This basically means that more info on 3.0 call -> https://youtu.be/hN6aE3Ebn08?t=1105 (specific moment pointed) thoughts? |
|
Recap of today spec 3.0 meeting:
|
Co-authored-by: Dale Lane <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
|
Kudos, SonarCloud Quality Gate passed!
|
|
Kudos, SonarCloud Quality Gate passed!
|
|
@char0n we are not able to merge without your approval as in the past you requested changes |
|
@derberg approval provided |
|
Kudos, SonarCloud Quality Gate passed!
|
|
/rtm |
|
🎉 This PR is included in version 3.0.0-next-major-spec.18 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 3.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
I extended the CONTRIBUTING.md file with content for Breaking Change vs Non Breaking Change.
This PR Resolves #688