Git Product home page Git Product logo

Comments (7)

phadej avatar phadej commented on August 19, 2024

I think this is consistent change, but definitions of functions or values aren't mentioned anywhere. Non-breaking change talks only about addition of things (good), for example.

from pvp.

llelf avatar llelf commented on August 19, 2024

This doesn’t make much sense to me.
Every simple refactoring (changing definitions of ⟨…⟩ functions or values), among many other things, would be a breaking change then.

from pvp.

phadej avatar phadej commented on August 19, 2024

from pvp.

hvr avatar hvr commented on August 19, 2024

@phadej I'd suggest to clarify the kind of changes by adding a couple more words:

Breaking change. If any entity was removed, or the types of any entities or the definitions of datatypes, classes, functions or values were changed in a semantically observable way, or orphan instances were added or any instances were removed, then ...

from pvp.

hasufell avatar hasufell commented on August 19, 2024

@hvr that introduces some ambiguity. Changing a datatype should always be a breaking change, no matter if semantics are preserved or not. I can't figure out if the current wording means that or not, so I propose:

Breaking change. If any entity was removed, or the types of any entities or the definitions of datatypes, classes were changed, or orphan instances were added or any instances were removed, or the definitions of functions or values were changed in a semantically observable way, then ...

from pvp.

frasertweedale avatar frasertweedale commented on August 19, 2024

So, what about I fix a little bug in the function. The type does not change, but the behaviour does change in a semantically observable way. As a library maintainer, requiring a major version bump for this does not feel right. OTOH, a major change to semantics or intended behaviour does warrant a major version bump (though perhaps a better way would be a new symbol, and deprecation of the old, otherwise users will get caught by surprise).

I support an explicit mention of this scenario in the PVP, because it is a common and important scenario that maintainers deal with. But the current proposal is too strong. I would ignore it and rely on my own judgement about whether a behavioural change requires a major version bump or not. It is better that the PVP would set a minor version bump as the minimum requirement, with an accompanying admonition to consider whether the change warrants a major version bump, and perhaps some examples.

from pvp.

phadej avatar phadej commented on August 19, 2024

I don't remember which particular issue triggered opening this. I don't find changing of error formatting convincing enough anymore.

from pvp.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.