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

Unclear documentation on mixing break checking rules #32

Closed
jacobk opened this issue Feb 27, 2020 · 1 comment
Closed

Unclear documentation on mixing break checking rules #32

jacobk opened this issue Feb 27, 2020 · 1 comment

Comments

@jacobk
Copy link

jacobk commented Feb 27, 2020

I'm slightly confused by the current wording about breaking checkers:

The default is FILE, which is our recommendation to guarantee maximum compatibility across your users. As opposed to linting, you generally will not mix and exclude specific breaking change checkers, instead choosing one of these options:

It seems like I shouldn't use multiple ones but yet implies that I might want to (you generally will not). Are all checkers a strict superset of the lower levels? I.e. does WIRE_JSON include all checks from FILE, PACKAGE, etc.?

@bufdev
Copy link
Member

bufdev commented Feb 27, 2020

https://buf.build/docs/breaking-checkers#choosing-a-category explains this in detail

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants