RulesVerifier should ensure that at least one of Recommendation or Description is filled in a Rule
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 1k
- Forks
- 132
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
Github's sarif upload feature requires the Text property of the Help property of each Rule to be populated. This field is a plaintext representation of the message shown to a user when an issue is found. Some rules have neither of these fields and thus result in an empty text property which fails to be uploaded to github, see #530.
The rulesverifier should require that at least one of the description or the recommendation is set, and the standard rules should all have descriptions/recommendations.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect the RulesVerifier and the standard rule definitions first, using the empty SARIF Help.Text failure described in #530 as context. Confirm that validation requires at least one of Description or Recommendation, and that every standard rule satisfies that requirement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- security, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100