Totem icon indicating copy to clipboard operation
Totem copied to clipboard

Add a "strict" mode for versioning

Open erinknight242 opened this issue 5 years ago • 0 comments

Purpose Some users require any change to a contract to be deemed a breaking change. Setting strict mode would allow any future edits to a contract to only be made by creating a new major version.

Requirements

  • When creating a new contract, add a checkbox to set if that contract versioning is strict (TBD: visual design)
  • Once a contract is created in strict mode, it can not be turned off. A new contract would need to be created and the original one deleted to remove the strict mode.
  • There should be a visual indicator on the contract that shows it is in strict mode (TBD: visual design)

When Editing:

  • Contract metadata can be edited and saved without changing the version number (description, type, namespace, and deprecation date) Can a user create a minor version for metadata changes, or will only major version changes be saved? How to validate version number if the field is editable?
  • All rows of the contract grid are locked for editing
  • Instead of "Add New Field" button, there is an "Add New Version" button that copies the current contract details but with the major version bumped by default. New versions are also in "strict" mode.
  • "Edit manually" menu/window is still accessible so users could copy from it, but changes can not be saved. It is reset to the current value when closed.
  • Add validation for strict mode that the version number follows the determined rules above

erinknight242 avatar Sep 18 '19 16:09 erinknight242