Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document SemVer API surface #367

Open
ChristianMurphy opened this issue Jun 27, 2019 · 1 comment
Open

Document SemVer API surface #367

ChristianMurphy opened this issue Jun 27, 2019 · 1 comment
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@ChristianMurphy
Copy link
Member

Document how changes affect the versioning.
Provide some examples.

@ChristianMurphy
Copy link
Member Author

ChristianMurphy commented Jun 27, 2019

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 ChristianMurphy self-assigned this Jun 27, 2019
@ChristianMurphy ChristianMurphy added enhancement New feature or request help wanted Extra attention is needed labels Jun 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant