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

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

Open
ToddCooper opened this issue Mar 7, 2023 · 1 comment
Assignees
Labels
Comment Review Comment of some sort from somewhere sometime Wiki Content Changes / features for the repository wiki

Comments

@ToddCooper
Copy link
Collaborator

Section Number

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

Priority

  • Medium: Significant issue or clarification. Requires discussion, but should not lead to long debate.

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 ToddCooper added Wiki Content Changes / features for the repository wiki Comment Review Comment of some sort from somewhere sometime Comment NEW A submitted comment waiting to be reviewed and dispositioned labels Mar 7, 2023
@ToddCooper ToddCooper added this to the SDPi 1.0 milestone Mar 7, 2023
@ToddCooper
Copy link
Collaborator Author

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 ToddCooper removed the Comment NEW A submitted comment waiting to be reviewed and dispositioned label Mar 10, 2023
@ToddCooper ToddCooper modified the milestones: SDPi 1.0, SDPi 1.1 dev Mar 28, 2023
@ToddCooper ToddCooper added the Release Candidate Issue is being considered for the next release label Feb 9, 2024
@ToddCooper ToddCooper removed the Release Candidate Issue is being considered for the next release label Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Comment Review Comment of some sort from somewhere sometime Wiki Content Changes / features for the repository wiki
Projects
Status: Todo
Development

No branches or pull requests

3 participants