Code Monkey home page Code Monkey logo

Comments (3)

ntwb avatar ntwb commented on June 30, 2024

Draft text via WordPress-Coding-Standards/stylelint-config-wordpress#97

## Semantic Versioning Policy

stylelint-config-standard follows [semantic versioning](http://semver.org). However, due to the nature of stylelint as a code quality tool, it's not always clear when a minor or major version bump occurs. To help clarify this for everyone, based on stylelint's [semantic versioning policy](https://github.com/stylelint/stylelint#semantic-versioning-policy) which is in turn based on ESLint's [semantic versioning policy](https://github.com/eslint/eslint#semantic-versioning-policy), we've defined the following subset of stylelint's semantic versioning policy for stylelint-config-standard:

-   Patch release (intended to not break your lint build)
    -   A bug fix in a rule that results in stylelint reporting fewer errors.
    -   Improvements to documentation.
    -   Non-user-facing changes such as refactoring code, adding, deleting, or modifying tests, and increasing test coverage.
    -   Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone).

-   Minor release (might break your lint build)
    -   A bug fix in a rule that results in stylelint reporting more errors.
    -   A new rule is added.
    -   A new option to an existing rule that does not result in stylelint reporting more errors by default.
    -   An existing rule is deprecated.

-   Major release (likely to break your lint build)
    -   A change in the documented behaviour of an existing rule results in stylelint reporting more errors by default.
    -   An existing rule is removed.

According to our policy, any minor update may report more errors than the previous release (ex: from a bug fix). As such, we recommend using the tilde (`~`) in `package.json` e.g. `"stylelint": "~7.2.0"` to guarantee the results of your builds.

The above is taken from the upcoming stylelint v8 semver policy and needs reviewing

from stylelint-config-standard.

jeddy3 avatar jeddy3 commented on June 30, 2024

Should we add the Semantic Version Policy from stylelint? (Adapted if needed)

I don't think so. This package is independent of, and quite different to, the stylelint package. This package is a config, whereas stylelint is a build tool. The ~ approach, as you said, is about a balance for build tools. For a config however, every addition is very likely to break someone's build and I suggest we stick to our current policy of a major release for any removal, change or addition.

from stylelint-config-standard.

ntwb avatar ntwb commented on June 30, 2024

Thanks, makes sense 👍

from stylelint-config-standard.

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.