[Docs] Update rules authoring documentation to explicitly call out required files in regard to a ruleset #776
Labels
documentation
Improvements or additions to documentation
needs-kind
Indicates an issue or PR lacks a `kind/foo` label and requires one.
needs-priority
Indicates an issue or PR lacks a `priority/foo` label and requires one.
needs-triage
Indicates an issue or PR lacks a `triage/foo` label and requires one.
Milestone
To help avoid confusion from new users creating custom rules, lets do a pass over the rules authoring content and be explicit on what fields are required or optional.
Specifically, ensure we go over the section on the ruleset file:
https://github.com/konveyor/analyzer-lsp/blob/main/docs/rules.md#ruleset
This issue is from some confusion we've seen in past where the
name
parameter was not set on a ruleset and it caused the custom rules to not work.The text was updated successfully, but these errors were encountered: