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

Enforce order, completeness, and correctness in rule lists #368

Open
hudlow opened this issue Feb 2, 2022 · 0 comments
Open

Enforce order, completeness, and correctness in rule lists #368

hudlow opened this issue Feb 2, 2022 · 0 comments

Comments

@hudlow
Copy link
Member

hudlow commented Feb 2, 2022

We have lists of Spectral rules in a couple of places:

In these lists, we'd benefit from build checks to make sure:

  1. Rules are listed in alphabetical order to make rules easier to find and conflicts less likely when adding rules.
  2. All Spectral rules are listed and given an explicit default, so we don't miss any when doing a Spectral update.
  3. Defaults listed in the documentation are correct.

Additionally, it looks like we may not be listing our custom Spectral rules in the documentation at all, so we probably need to start doing that and enforcing completeness/correctness in that respect as well.

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

1 participant