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

Change diagram to suggest more common numbering progression #20

Merged
merged 2 commits into from
Jan 19, 2018
Merged

Change diagram to suggest more common numbering progression #20

merged 2 commits into from
Jan 19, 2018

Conversation

xkollar
Copy link
Contributor

@xkollar xkollar commented Jan 18, 2018

Possibly related to issue #14.

Previously diagram seemed to suggest that changes should be

0.1.1 -> 0.2.1
or -> 1.1.1

instead of
-> 0.2.0
or -> 1.0.0

which is not how package versioning on Hackage seems to work…

Rest of the text does not seem to specify what should happen with numbers "under bump".

@xkollar xkollar changed the title Diagram fix Change diagram to suggest more common path Jan 18, 2018
@xkollar xkollar changed the title Change diagram to suggest more common path Change diagram to suggest more common numbering Jan 18, 2018
@xkollar xkollar changed the title Change diagram to suggest more common numbering Change diagram to suggest more common numbering progression Jan 18, 2018
Previously diagram seemed to suggest that changes should be

0.1.1 -> 0.2.1
   or -> 1.1.1

instead of
      -> 0.2.0
   or -> 1.0.0

which is not how package versioning on Hackage seems to work…
@hvr
Copy link
Member

hvr commented Jan 18, 2018

I think this would be more accurate if the wording was also changed to say that "your release version should be at least"; as there's no formal requirement to release in a particular order nor to reset components to 0. In fact, there is no reference to the time dimension. The PVP merely states relationships between versions, without making any temporal reference.

@xkollar
Copy link
Contributor Author

xkollar commented Jan 19, 2018

Image states "should", which I understand as "no a hard requirement, just guideline"… of course, people might have reasons to do something else.

Anyway, I have created additional commit, you can compare what you like more :-).

@hvr hvr merged commit e993ad0 into haskell:master Jan 19, 2018
@hvr
Copy link
Member

hvr commented Jan 19, 2018

Thanks!

It's just confusing if the diagram implies more "shoulds" than the PVP text implies and implying that you "should" reset to .0 is not mentioned anywhere in the textual PVP. That's all :-)

@xkollar
Copy link
Contributor Author

xkollar commented Jan 19, 2018

Np, I just though that what diagram suggested originally was not ideal even as a suggestion and that reset is better… Thanks for the merge :-). When it will get deployed O:-)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants