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

Add semantic versioning policy #312

Merged
merged 1 commit into from Nov 30, 2022
Merged

Add semantic versioning policy #312

merged 1 commit into from Nov 30, 2022

Conversation

bmish
Copy link
Owner

@bmish bmish commented Nov 29, 2022

Our policy is similar to prettier's:

If prettier produces a different output on two different versions, that's not a breaking change. Ideally prettier will never have any breaking changes, but if there are, it would be to the the API/CLI itself, not the output.

Prettier makes bug fixes and formatting tweaks to the generated output in minor/patch versions. eslint-doc-generator and prettier are both in the business of generating large amounts of content that are susceptible to a diff being triggered upon even minor bug fixes or formatting tweaks. In both cases, simply re-running the tool fixes the diff.

Also related:

@bmish bmish added the documentation Improvements or additions to documentation label Nov 29, 2022
@bmish bmish merged commit 7b50ec1 into main Nov 30, 2022
@bmish bmish deleted the semver-policy-doc branch November 30, 2022 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant