uPortal-web-components icon indicating copy to clipboard operation
uPortal-web-components copied to clipboard
verified publisher icon uPortal-Project

Document SemVer API surface

Open ChristianMurphy opened this issue 6 years ago • 1 comments

Document how changes affect the versioning. Provide some examples.

ChristianMurphy avatar Jun 27 '19 21:06 ChristianMurphy

Initial thoughts. The API surface for web components is defined by:

  1. the CSS variables
  2. the HTML attributes

Changes that don't affect either are patches. Changes that add new variables/attributes are a minor release. Changes the remove variables or attributes are a major release.

  1. The framework version.

New major versions of Vue may need to be part of a major release here. The main reason to consider it a part of the API, is currently that Vue version needs to be defined outside the component. If components were bundled with Vue, the Vue version would have not have an effect.

ChristianMurphy avatar Jun 27 '19 21:06 ChristianMurphy