-
Notifications
You must be signed in to change notification settings - Fork 10
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
doc: document protocol versioning policy #56
Conversation
doc/VERSIONING.md
Outdated
|
||
Protocol versions are bound to the first version of the `metarhia-jstp` package | ||
that implements the specific version of the JSTP protocol. When the package | ||
reaches 1.0.0, the protocol version will unconditionally bumped to 1.0.0 too, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably missing "be" after "will".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I will update the commit in a moment.
637c461
to
5a0442a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@tshemsedinov still waiting for you to review the proposal. |
Does it mean that protocol version will be equal to package version after 1.x? |
@tshemsedinov to the first version of the package that introduced the changes found in this version of protocol, to be exact. Version 1.0.0 is a special one in one case: if package version 1.0 introduces no changes to protocol since, for example, version 0.9, then as soon as package version 1.0 is released, the protocol version is bumped to 1.0 anyway, just the specification is identical for protocol versions 0.9 and 1.0. The reason is that when we release the first stable version of the package, we want the protocol version to indicate that it is stable too, and vice versa, before until we have released the first stable version of the package, we cannot guarantee that the protocol is already stable since some changes in functionality require changes in the protocol |
@tshemsedinov alternatively, the protocol can be semantically versioned by itself, independently of this package, as soon as we reach 1.0.0. |
@aqrln, in my opinion, alternative option to version protocol by itself is better if we are going to create formal specification of the protocol (which I hope we will). |
@belochub yeah, after some thinking about it I think I would prefer the mixed approach:
@tshemsedinov, what do you think about it? |
Great |
5a0442a
to
52878d8
Compare
I've just updated the commit so that the document reflects the consensus of the discussion. @belochub, @tshemsedinov, please check it out and say if it LGTY. |
doc/VERSIONING.md
Outdated
|
||
Before the package reaches version 1.0.0, the protocol version is bound to the | ||
first version of the `metarhia-jstp` package that implements the specific | ||
specification of the protocol. It would be nice to have it versioned |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe avoid phrase "specific specification"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@belochub reworded the sentence for clarity and to be more stylistically correct.
In order to communicate with developers of alternative implementations and be reasonable about compatibility, we need to assign versions to the protocol too. This commit documents the protocol versioning policy.
52878d8
to
41820a2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
In order to communicate with developers of alternative implementations and be reasonable about compatibility, we need to assign versions to the protocol too. This commit documents the protocol versioning policy. PR-URL: #56
Landed in 51c763f. |
In order to communicate with developers of alternative implementations and be reasonable about compatibility, we need to assign versions to the protocol too. This commit documents the protocol versioning policy. PR-URL: #56
In order to communicate with developers of alternative implementations and be reasonable about compatibility, we need to assign versions to the protocol too. This commit documents the protocol versioning policy. PR-URL: #56
In order to communicate with developers of alternative implementations and be reasonable about compatibility, we need to assign versions to the protocol too. This commit documents the protocol versioning policy. PR-URL: #56
In order to communicate with developers of alternative implementations and be reasonable about compatibility, we need to assign versions to the protocol too. This commit documents the protocol versioning policy. PR-URL: #56
In order to communicate with developers of alternative implementations and be reasonable about compatibility, we need to assign versions to the protocol too. This commit documents the protocol versioning policy. PR-URL: #56
In order to communicate with developers of alternative implementations and be reasonable about compatibility, we need to assign versions to the protocol too. This commit documents the protocol versioning policy. PR-URL: #56
In order to communicate with developers of alternative implementations and be reasonable about compatibility, we need to assign versions to the protocol too. This commit documents the protocol versioning policy. PR-URL: #56
In order to communicate with developers of alternative implementations and be reasonable about compatibility, we need to assign versions to the protocol too. This PR documents the protocol versioning policy (see details in the changed file).
According to this proposal, e.g., the current version of the protocol is 0.5 and the next one, if #54 lands, is 0.7.
@tshemsedinov, @belochub, do you agree with this proposal or you have other ideas about how we must assign versions to the protocol?