DR-000036 - Breaking Changes

Owned by Jeremy Huff
Last updated: May 06, 2024 by Jenn Colt
2 min read
Submitted Date

 

Approved Date

 

StatusACCEPTED
ImpactLOW

 

Overrides/Supersedes 

N/a

RFC 

https://github.com/folio-org/rfcs/blob/master/text/0003-folio-breaking-changes.md

Stakeholders

This ADR pertains to all development, devops, operations and release management professionals who contribute to the FOLIO project.

It is recommended that the following Slack channels be notified of this ADR: #development, #devops, #stripes, and #sys-ops

It is also recommended that Oleksii Petrenko be considered a stakeholder

Contributors

This ADR has been prepared by the FOLIO Technical Council Subgroup on Breaking Changes, whose members are:

Jeremy Huff Marc Johnson Jakub Skoczen Zak Burke Maccabee Levine Ankita Sen 

Approvers

Jeremy Huff Ankita Sen Jenn Colt Maccabee Levine Marc Johnson Taras Spashchenko 

Background/Context

This ADR is a response to the approval of RFC 0003-folio-breaking-changes. This RFC was the product of the FOLIO Technical Council Subgroup on Breaking Changes.

Assumptions

That a breaking change, and its impact on versioning, is understood within the definitions laid out by semantic versioning practices.

Constraints

N/a

Rationale

The FOLIO Technical Council Subgroup on Breaking Changes was charged with determining the appropriate mechanisms for communicating breaking changes during the development and release processes.

In discussing this issue, it became apparent that a shared understanding of what does or does not constitute a breaking change, within the context of FOLIO development, was needed in order to provide further guidance on the topic.

Decision

The determination that any change is or is not breaking should be consistent with the guidelines laid out in the 0003-folio-breaking-changes RFC

Implications

  • Pros
    • Development, devops, operations, and release management professionals contributing to the FOLIO project can utilize a common understanding of what does or does not constitute a breaking change.  
  • Cons
    • Some practices currently in effect may be inconsistent with the guidance laid out in RFC 0003-folio-breaking-changes. These practices will need to change, and there may be a switching cost to this change.

Other Related Resources

semantic versioning