Readme: Version Update Rules #223
Open
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
lpsinger
reviewed
Nov 27, 2024
gcn/notices/core/Alert.schema.json
Outdated
| @@ -33,9 +33,9 @@ npm install | |||
|
|
|||
| npm install | |||
|
|
|||
| 3. Tag a new version by running the following command: `npm version [ major | minor | patch ]`. Choose `major`, `minor`, or `patch` depending on the kind of update according to [Semantic Versioning](https://semver.org) rules. | |||
| 3. Tag a new version by running the following command: `npm version [ major | minor | patch ]`. Choose `major`, `minor`, or `patch` depending on the kind of update according to [Semantic Versioning](https://semver.org) rules. Updates are categorized as major, minor, or patch, depending on the type of change. A major change is defined as any modification that breaks compatibility with the core schema, such as a change in a property or the addition of a new property that affects the mission pipelines. Introducing a new mission and new core schema constitutes a minor change, while modifying the new mission schema and adding a new property to the core schema are considered patches. | |||
There was a problem hiding this comment.
This just looks like a summary of SemVer. What is the value of adding it?
There was a problem hiding this comment.
This includes examples and we prefer documents to be self-consistent for clarity.
Vidushi-GitHub
force-pushed
the
schema/rules
branch
from
7dcf0d5
to
f13b27f
Compare
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.
Set of rules for Unified Schema Versioning on the Notices producers document:
(a) Includes version type
(b) Announce to team and community
(c) Mission page rule
Resolves ##142