[OASIS Issue Tracker] (ODATA-1467) Keep a CHANGELOG.md, use Semantic Versioning for each vocabulary

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

Ralf Handl created ODATA-1467:
---------------------------------

             Summary: Keep a CHANGELOG.md, use Semantic Versioning for each vocabulary
                 Key: ODATA-1467
                 URL: https://issues.oasis-open.org/browse/ODATA-1467
             Project: OASIS Open Data Protocol (OData) TC
          Issue Type: Task
          Components: Vocabularies
         Environment: Proposed
            Reporter: Ralf Handl


We recently published a "breaking" change with [https://github.com/oasis-tcs/odata-vocabularies/pull/127]Â- removing {{EntityContainer}} from the {{AppliesTo}} list of a term.

We claim that {{AppliesTo}} is only a recommendation, but some tools actually take this literally and do not apply terms to model elements not listed.

Independent of whether this was really a breaking change we should:
 * Use [Semantic Versioning|https://semver.org/spec/v2.0.0.html]Âfor each of our vocabulary files and add a version number using annotation {{Core.SchemaVersion}} to the schema of each vocabulary
 ** We may want to adapt the description of {{Core.SchemaVersion}} and also mention vocabularies in addition to services, or "abstract" to talk about schemas
 * Keep a [Changelog|https://keepachangelog.com/en/1.0.0/]Âin the repository root as a file {{CHANGELOG.md}} and mention all (interesting) changes there.
 ** "Interesting" are all major changes (rename/remove stuff), and most of the minor changes (add new stuff), but probably not patches.

Â



--
This message was sent by Atlassian Jira
(v8.3.3#803004)