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

Some checks have very verbose "names" in GitHub code scanning #4163

Closed
TWiStErRob opened this issue Oct 5, 2021 · 3 comments
Closed

Some checks have very verbose "names" in GitHub code scanning #4163

TWiStErRob opened this issue Oct 5, 2021 · 3 comments

Comments

@TWiStErRob
Copy link
Member

This affects multiple rules.

Expected Behavior of the rule

When looking at https://github.com/org/repo/security/code-scanning I want to see a short quick summary of the issues, not repeated details and default values which I might've overridden anyway. Sadly I noticed that Issue doesn't have a title and a description field like Android-lint, so I think what's missing is a consistent scheme of defining check descriptions. What goes into the Issue definition and what goes into the documentation.

Context

I did as suggested by #3045 (comment) and I managed to set up Detekt. When I first ran it (with some issues to test), I received a long list with some very verbose titles. When looking at this list I would want to see a quick summary.
image

Here's one long one when I open it:
image

@3flex
Copy link
Member

3flex commented Apr 26, 2022

Closing, see #4750 (comment)

@3flex 3flex closed this as completed Apr 26, 2022
@TWiStErRob
Copy link
Member Author

I think agree with @BraisGabin that this is a generic issue, because the issue is systematic. I think the solution is to add a single test (is there a rule base test?) that validates that the description of every rule is <100 (arbitrary) characters and then fix the long ones. No-one should manually read and validate messages... 😅

@BraisGabin
Copy link
Member

That sounds like a good idea to me.

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

No branches or pull requests

4 participants