-
Notifications
You must be signed in to change notification settings - Fork 259
Closed
Labels
closed-for-stalenesscomplianceMissing or broken compliance testsMissing or broken compliance testsdocumentationThis is a problem with documentation.This is a problem with documentation.effort/smallSmall work item – less than a day of effortSmall work item – less than a day of effort
Description
Update the CONTRIBUTING.md file to reflect that any breaking change in jsii protocols (Assembly schema or semantics, runtimes behavior, ...) must go through the RFC process and be provided sufficient time & attention to assert that:
- Sufficient consideration was given to all alternatives to breaking, and that rejection of those has been sufficiently motivated
- Proactively documented a migration guide to help users affected by the breakage to move past it with as little effort as possible
- Have comprehensively documented the reasons why the breaking change happens and the though process that led to it
Metadata
Metadata
Assignees
Labels
closed-for-stalenesscomplianceMissing or broken compliance testsMissing or broken compliance testsdocumentationThis is a problem with documentation.This is a problem with documentation.effort/smallSmall work item – less than a day of effortSmall work item – less than a day of effort