search

IHE / DEV.SDPi

IHE Devices Service-oriented Device Point-of-care Interoperability (SDPi) profiles supplement specification materials and related tooling.
9 stars 1 forks source link

Update wiki major.minor.fix documentation to include "fix" level guidelines #62

Open ToddCooper opened 1 year ago

ToddCooper commented 1 year ago

Section Number

Wiki - SDPi Editorial Planning & Versions article - section Major & Minor Versioning

Priority

Issue

Wiki major/minor version article does not mention the 3rd "fixes" component of the version labeling. Guidance should be added for this component and linked to the web semantic versioning article.

Proposed Change

Update the Major & Minor Versioning article section per the proposal above.

ToddCooper commented 1 year ago

From email thread between @d-gregorczyk and @ToddCooper :

  1. (Todd) 3rd digit should be used ONLY for fixes and no capability / content enhancements? And by fixes, do we mean typos, broken links, grammar and requirements language that is wrong.
  2. (David) Fix versions should only contain editorial changes. For me, it is just important to have a description of the versioning concept I can draw a link to as we’re deviating from classic SW semantic versioning (for apparent reasons, we’re writing documents, that’s a different thing). If we were basing our document on SW semantic versioning, I would’ve linked to the semantic versioning info web site in the changelog file. Instead, I now link to our github wiki to guide people to an explanation of versioning in SDPi (which is important to present as the changelog includes headings with version numbers).
  3. Add link to semantic versioning web page.
ToddCooper commented 4 days ago

SDPi Workshop #4 - Pushed to 2.1 along with the general wiki update issue.