Release documentation update #218
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…links to create and view issues
c-schuler
approved these changes
Oct 4, 2022
brynrhodes
requested changes
Oct 4, 2022
README.md
Outdated
| This repository will leverage a branching strategy to maintain multiple versions of opioid recommendations (currently 2016 and 2022) and their respective IG's. This will use semantic versioning on releases to make it clear which version of the recommendations the release is for. Any release for 2022 version will be v2022.#.# and any that are 2016 will be v2016.#.#. | ||
| This repository will leverage a branching strategy to maintain multiple versions of the CDC opioid recommendations (currently 2016 and 2022) and their respective IG's. This will use semantic versioning on releases to make it clear which version of the recommendations the release is for. | ||
| The format used will be major.minor.patch | ||
| - major is for new CDC Recommendations |
There was a problem hiding this comment.
Consider: major is used to refer to the guideline publication year (e.g. 2016)
brynrhodes
requested changes
Oct 4, 2022
brynrhodes
approved these changes
Oct 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This answers issue #216 first point:
Would be good to explain the significance of the minor and patch versions:
major: Guideline version
minor: New features and capabilities, but not breaking changes
patch: Bug fixes and technical corrections.
Would be good to illustrate that in the diagram with a 2022-Fix branch and 2016-Fix branch showing the version increment
Snd the point:
For 2022, the IG and all the artifacts in it are "draft" status.
For 2016,, the IG is active, and any artifact we have pilot experience with is "active", all the rest are "draft"
Other parts of the issue forthcoming.