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.

Sign up for GitHub

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

Jump to bottom

RFE: Tool / Check should provide suggested remediation #63

Closed
JasonKeirstead opened this issue Nov 12, 2020 · 5 comments
Closed

RFE: Tool / Check should provide suggested remediation #63

JasonKeirstead opened this issue Nov 12, 2020 · 5 comments
Labels
kind/docs Improvements or additions to documentation kind/enhancement New feature or request

Comments

@JasonKeirstead
Copy link

Currently, a check indicates a simple pass/fail with confidence. For a developer, this does not actually help them know how they should improve the situation. Checks should provide a suggested remediation on how to fix or improve.
@inferno-chromium inferno-chromium added the kind/docs Improvements or additions to documentation label Nov 12, 2020
@inferno-chromium
Copy link
Contributor

inferno-chromium commented Nov 12, 2020 •
edited
Loading

You want to propose some recommendation in the doc, maybe https://github.com/ossf/scorecard/blob/main/checks.md ? PRs welcome!

@JasonKeirstead
Copy link
Author

@inferno-chromium I would argue it should output in the tool itself. If there is consensus on that I will try to work on a small PR to get it started.

@inferno-chromium inferno-chromium removed the kind/docs Improvements or additions to documentation label Nov 12, 2020
@inferno-chromium
Copy link
Contributor

Yes i meant show the link in tool and improve documentation.

@dlorenc
Copy link
Contributor

dlorenc commented Nov 12, 2020

Yes, makes sense to me. I think having the remediation content itself live on some website with a short summary and links in the tool makes sense.

Some of the guidance could be multiple paragraphs or longer, which could be hard to read in a terminal.

@dlorenc dlorenc closed this as completed Nov 12, 2020
@dlorenc dlorenc reopened this Nov 12, 2020
@inferno-chromium inferno-chromium added kind/docs Improvements or additions to documentation kind/enhancement New feature or request labels Nov 12, 2020
@naveensrinivasan naveensrinivasan mentioned this issue Mar 24, 2021
Open
11 tasks
@naveensrinivasan
Copy link
Member

closing this to track it via #304

@naveensrinivasan naveensrinivasan mentioned this issue Apr 18, 2021
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/docs Improvements or additions to documentation kind/enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@naveensrinivasan @dlorenc @JasonKeirstead @inferno-chromium