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

[Docs] Update rules authoring documentation to explicitly call out required files in regard to a ruleset #776

Closed
jwmatthews opened this issue Feb 18, 2025 · 1 comment · Fixed by #778
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

Comments

@jwmatthews
Copy link
Member

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.

@jwmatthews jwmatthews added the documentation Improvements or additions to documentation label Feb 18, 2025
@jwmatthews jwmatthews added this to the Next milestone Feb 18, 2025
@konveyor-ci-bot
Copy link

This issue is currently awaiting triage.
If contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.
The triage/accepted label can be added by org members.

@konveyor-ci-bot konveyor-ci-bot bot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. 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. labels Feb 18, 2025
shawn-hurley added a commit that referenced this issue Feb 19, 2025
fixes #776

Signed-off-by: Shawn Hurley <shawn@hurley.page>
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 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.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant