FluidFramework icon indicating copy to clipboard operation
FluidFramework copied to clipboard

RFC: Breaking Changes and Supported Patterns

Open CraigMacomber opened this issue 1 year ago • 3 comments

Description

This is a proposal document for review, not an actual PR intended to be merged.

The PR tooling is being used as an easy what to collect feedback on a markdown file.

If this proposal is liked, this content can likely be refactored into a couple separate documents which some of our packages could opt into using to be more clear about what will and will not be a breaking change in their API.

Reviewer Guidance

The review process is outlined on this wiki page.

Questions:

  • Is the proposed approach of defining "Supported Patterns" and using them to clarify what changes are breaking and which ones are not something we want to adopt?
  • What do you think about some of the proposed rules for the supported patterns? Do they seem like something we want to adopt?
  • Do you have suggestions for additional rules we should add?
  • Do you know of related work that should be added to that section?

CraigMacomber avatar Mar 04 '23 02:03 CraigMacomber