Skip to content
This repository has been archived by the owner on Jun 1, 2022. It is now read-only.

Add a "strict" mode for versioning #42

Open
erinknight242 opened this issue Sep 18, 2019 · 0 comments
Open

Add a "strict" mode for versioning #42

erinknight242 opened this issue Sep 18, 2019 · 0 comments
Labels
enhancement New feature or request javascript Pull requests that update Javascript code needs requirements Issue needs to be updated to include additional information before development can begin .NET Pull requests that update .net code

Comments

@erinknight242
Copy link
Collaborator

erinknight242 commented Sep 18, 2019

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 erinknight242 added enhancement New feature or request .NET Pull requests that update .net code javascript Pull requests that update Javascript code priority This ticket should take priority over others needs requirements Issue needs to be updated to include additional information before development can begin labels Sep 18, 2019
@erinknight242 erinknight242 removed the priority This ticket should take priority over others label Sep 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request javascript Pull requests that update Javascript code needs requirements Issue needs to be updated to include additional information before development can begin .NET Pull requests that update .net code
Projects
None yet
Development

No branches or pull requests

1 participant