Docs: clarify minor releases and suggest using `~ to version

[hzoo]

What issue does this pull request address?

#6795 (comment)

I don't think anyone is suggesting the default be 0 or 1 just that any default was set. But according to the policy that will happen. I think we just need to signal that if you don't want a "breaking change / breaking lint build" (in terms of other projects) you should be using ~ in package.json for ESLint since it can be surprising.

@hzoo that's a good point. Want to put together a PR for the readme with that suggestion?

What changes did you make? (Give an overview)

A docs change to the readme to suggest using ~ so users don't get unexpected changes.

Wording can be changed, maybe mention what I said about it being surprising otherwise.

aside: another thing I thought of was when doing minor updates that cause more fixes that we point that out either in the changelog, the summary, or commit message. Then users have more of an idea of what will be breaking (and in those cases we can also explain if theres an easy migration to fix (an autofix for it)

[mention-bot]

@hzoo, thanks for your PR! By analyzing the annotation information on this pull request, we identified @nzakas, @platinumazure and @alberto to be potential reviewers

[eslintbot]

LGTM

[jquerybot]

Thank you for your pull request. It looks like this may be your first contribution to a jQuery Foundation project, if so we need you to sign our Contributor License Agreement (CLA).

📝 Please visit http://contribute.jquery.org/CLA/ to sign.

After you signed, the PR is checked again automatically after a minute. If there's still an issue, please reply here to let us know.

---

If you've already signed our CLA, it's possible your git author information doesn't match your CLA signature (both your name and email have to match), for more information, check the status of your CLA check.

[eslintbot]

Thanks for the pull request, @hzoo! I took a look to make sure it's ready for merging and found some changes are needed:

• The commit summary must be 72 characters or shorter. Please check out our guide for how to properly format your commit summary and update it on this pull request.

Can you please update the pull request to address these?

(More information can be found in our pull request guide.)

[eslintbot]

LGTM

[hzoo]

Weird I guess it was since I used the website to edit and I turned on that private email option on github so the CLA failed, not sure.

[alberto]

I would clarify that a minor will only report more errors if the case of bugs, when the error should have been reported in the first place.

[nzakas]

Let's not use the term "breaking change" here, as I think it will confuse people. It's better to say that any minor update may include more warnings than the previous release. As such, we recommend using the tilde if you want to guarantee the results of your builds.

[nzakas]

@alberto that's not strictly true. We may add a new option that we feel is important to be on by default and let people opt-out rather than opting-in.

[eslintbot]

LGTM

[alberto]

@nzakas That's news to me. I don't see that discussed in #6244 either

[alberto]

FWIW, the only conversation I recall us having about this is in #5845 and you seemed to have the opposite opinion.

I'm sorry for being insistent on this, I'm not against it, I'm just trying to understand it, because I am a bit confused now regarding breaking changes in rule options. And I would like to make it very clear in the docs what could make your build fail, so people can choose appropriately.

[nzakas]

@alberto the policy says "a new rule option" for minor version. It doesn't specify whether the option is enabled by default or not. And sorry, I don't see where in #5845 I specified a different preference. Can you point it out?

[nzakas]

This pull request LGTM. @alberto let's continue the discussion at the TSC meeting.