Flesh out definition of breaking vs. non-breaking changes#295
Merged
hunterowens merged 1 commit intoApr 29, 2019
Merged
Conversation
This commit adds a section to the release guidelines doc clarifying the distinction between breaking and non-breaking changes, including an enumeration of what kinds of changes fall in each category. This builds on language added in openmobilityfoundation#286; I didn't modify those templates here since their description of breaking vs. non-breaking is still accurate. I think the most likely area of controversy here is the handling of enum values. My inclination would actually be to treat changes to enum values as breaking changes, but it seems like the consensus during the 0.3.1 process so far has been that the benefits of having a lightweight process for updating enums outweigh the risk of breaking clients that are doing stricter validations. Fixes openmobilityfoundation#279
hunterowens
approved these changes
Apr 29, 2019
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 commit adds a section to the release guidelines doc clarifying the
distinction between breaking and non-breaking changes, including an
enumeration of what kinds of changes fall in each category. This builds
on language added in #286; I didn't modify those templates here since
their description of breaking vs. non-breaking is still accurate.
I think the most likely area of controversy here is the handling of enum
values. My inclination would actually be to treat changes to enum values
as breaking changes, but it seems like the consensus during the 0.3.1
process so far has been that the benefits of having a lightweight
process for updating enums outweigh the risk of breaking clients that
are doing stricter validations.
Fixes #279
Is this a breaking change
Provideroragencyprovideragency