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

Clarify rule two #40

Open
Taneb opened this issue Feb 23, 2022 · 2 comments
Open

Clarify rule two #40

Taneb opened this issue Feb 23, 2022 · 2 comments

Comments

@Taneb
Copy link

Taneb commented Feb 23, 2022

Rule 2 currently says:

Non-breaking change. Otherwise, if only new bindings, types, classes, non-orphan instances or modules (but see below) were added to the interface, then A.B MAY remain the same but the new C MUST be greater than the old C. Note that modifying imports or depending on a newer version of another package may cause extra non-orphan instances to be exported and thus force a minor version change.

There's an ambiguity here. It could be read as requiring C to be increased only when A.B remains the same (which I believe to be intended), or it could be read as requiring C to be increased regardless of whether A.B remains the same. Could this wording be made more clear?

@bergmark
Copy link

I agree, if the initial version is v0=A.B.C then v1 must have an increment in at least one of those components

@juhp
Copy link

juhp commented Apr 10, 2022

I suppose the intended wording could be "but then ".

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

No branches or pull requests

3 participants