From 40ce38c3aa61b2e8a066c3b47c1860864392d6e8 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Thu, 20 Oct 2022 00:24:01 +0100 Subject: [PATCH 1/6] Updated CONTRIBUTING.md with new content. I extended the CONTRIBUTING.md file with content for Breaking Change vs Non Breaking Change. --- CONTRIBUTING.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c82242d80..7c7cd1068 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,6 +78,18 @@ move forward. The AsyncAPI spec, despite describing technical behavior, is intended to be read by people. Use natural tone and include motivation and examples. +## Breaking Change vs Non Breaking Change + +The specification is 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 + +_Breaking changes:_ +- Making a property required +- Making a property optional +- Removing a property +- Changing the type of a property in any way ## RFC Contribution Champions @@ -245,4 +257,4 @@ A pull request can be merged if all the following conditions are met: ## References -This document was adapted from the [GraphQL Specification Contribution Guide](https://github.com/graphql/graphql-spec/blob/main/CONTRIBUTING.md). \ No newline at end of file +This document was adapted from the [GraphQL Specification Contribution Guide](https://github.com/graphql/graphql-spec/blob/main/CONTRIBUTING.md). From d84511e5d87ebffd65ef38e11eb5aae58b58edca Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 22 Oct 2022 05:35:47 +0100 Subject: [PATCH 2/6] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fran Méndez --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c7cd1068..3d08da4cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,7 +80,7 @@ move forward. ## Breaking Change vs Non Breaking Change -The specification is 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. +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 From 9b937fcc06e55b870a014264a194061954d8ad0a Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Thu, 16 Mar 2023 06:03:50 +0100 Subject: [PATCH 3/6] Update CONTRIBUTING.md Co-authored-by: Dale Lane --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d08da4cb..3c8b1f681 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,6 +86,7 @@ _Non-breaking changes:_ - Adding a property _Breaking changes:_ +- Adding a new required property - Making a property required - Making a property optional - Removing a property From 4926470c8985e00a4f35a5bc8f80fbe6830e2868 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Thu, 16 Mar 2023 06:04:02 +0100 Subject: [PATCH 4/6] Update CONTRIBUTING.md Co-authored-by: Dale Lane --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c8b1f681..1c8470700 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,7 +83,7 @@ move forward. 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 +- Adding a new optional property _Breaking changes:_ - Adding a new required property From 2e6d03a9d7cdad8ae45aa0e6f14ea09b1034d776 Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Thu, 16 Mar 2023 06:06:41 +0100 Subject: [PATCH 5/6] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Vladimír Gorej --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c8470700..0eed4940c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,7 +90,7 @@ _Breaking changes:_ - Making a property required - Making a property optional - Removing a property -- Changing the type of a property in any way +- Changing the type of a property in backward incompatible way ## RFC Contribution Champions From da826f7631154e7b0de99ac1aca1c53c114b7ede Mon Sep 17 00:00:00 2001 From: Tabah Baridule M Date: Sat, 15 Apr 2023 20:10:28 +0100 Subject: [PATCH 6/6] Update CONTRIBUTING.md Co-authored-by: Dale Lane --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0eed4940c..f6c619dd7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,7 +80,7 @@ move forward. ## Breaking Change vs Non Breaking Change -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. +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 it is not provided. _Non-breaking changes:_ - Adding a new optional property