Giter VIP home page Giter VIP logo

Comments (3)

jackfirth avatar jackfirth commented on July 19, 2024

@AlexKnauth - Can you think of anything else that's required before 1.0?

from lens.

jackfirth avatar jackfirth commented on July 19, 2024

@AlexKnauth This is what I'm thinking with regards to versioning post-1.0:

  • Nothing in the lens or a lens/* collection should break backwards compatibility. Non exhaustive list of backwards-incompatible changes:
    • Renaming or removing an export
    • Renaming or removing a subcollection
    • Changing the behavior of an export in any way such that what used to be valid non-error-ing uses of the export would behave differently
    • Moving an export from one subcollection to another (it should be re-provided instead)
  • New features should bump the major version. Once a new feature makes it into the main collection, it must commit to backwards compatibility. To add a new feature that you wish to allow backwards incompatible changes to, add it to unstable/lens instead of lens. This should bump the minor version.
  • Bugfixes and other minor behavioral changes to existing code that are visible to users of the package should bump the minor version.
  • Documentation changes, refactoring, added tests, reorganizations, etc. etc. do not need to bump the version provided it isn't practically possible for a user of the collection to tell the change happened.

This would lead to a pattern where new exports would get added in "batches", as they are iterated on in the unstable collection until it's decided there's enough new stable features to justify bumping the major version.

from lens.

jackfirth avatar jackfirth commented on July 19, 2024

Bumping the version to 1.0 now.

from lens.

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.