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

RFC011: Describe how changes relate to versions #222

Open
reinkrul opened this issue Oct 24, 2022 · 0 comments
Open

RFC011: Describe how changes relate to versions #222

reinkrul opened this issue Oct 24, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good-to-go Issue is discussed and ready to be fixed

Comments

@reinkrul
Copy link
Member

Document the Way of Working regarding how to deal with changes:

  1. We use semantic versioning
  2. Backwards compatible changes increment the minor version in the JSON-LD context URL, e.g.:
    { "@context": "https://nuts.nl/credentials/v1.1" }
    The JSON-LD context URI (base property inside the context) does not change, e.g.:
    { "base": "https://nuts.nl/credentials/v1"}
    This maintains backwards compatibility of integrations.
  3. Breaking changes increment the major version in both the URL and URI in the base property
  4. We don't use patch versions
@reinkrul reinkrul added documentation Improvements or additions to documentation good-to-go Issue is discussed and ready to be fixed labels Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good-to-go Issue is discussed and ready to be fixed
Projects
None yet
Development

No branches or pull requests

1 participant