OHDSI / OHDSI/CommonDataModel

Clarification on OMOP CDM versioning standards

Open
#811 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
1.1k
Forks
508
Avg merge
1h 30m
Merged PRs (30d)
3

Description

I can see that OMOP CDM versioning is x.y.z based on the releases and tags. I also see that the website has changes from one x.y version to the next x.y version. I'm wondering if changes from x.y.z to the next x.y.z is disallowed from changing the tables and columns but is allowed other potential schema changes.

Is there any documentation on how OMOP CDM versioning is handled and what a major, minor and build change is allowed or not allowed to have?

Should there be a changelog file in the repository (aka NEWS.md like many other R packages?)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's releases and tags alongside the website changes between x.y versions. Document what major, minor, and build changes are allowed, then clarify whether a NEWS.md changelog should be maintained and what it should contain.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.