search

ossf / scorecard

OpenSSF Scorecard - Security health metrics for Open Source
https://scorecard.dev
Apache License 2.0
4.63k stars 504 forks source link

Update Code Section Format in Readme #4272

Open Jordin221 opened 4 months ago

Jordin221 commented 4 months ago

Describe the bug Under basic usage, the scorecard argument is copyable along with the output produced when the argument is ran.

Reproduction steps Steps to reproduce the behavior:

  1. visit this link
  2. copy the code section
  3. paste the code section and observe the results

Expected behavior We propose separating the command from the output to be copied on its own.

Additional context newIssueScreenshot @klbynum, @silasVM, and I could open a PR for this issue. :)

lelia commented 3 months ago

Hi @Jordin221, could you clarify what the desired formatting would be — something like this?

Scorecard can run using just one argument, the URL of the target repo:

scorecard --repo=github.com/ossf-tests/scorecard-check-branch-protection-e2e

Sample CLI output:

Starting [CII-Best-Practices]
Starting [Fuzzing]
Starting [Pinned-Dependencies]
[...]

@klbynum, @SilasVM, and I could open a PR for this issue. :)

Feel free to do so! 🙂

github-actions[bot] commented 3 weeks ago

This issue has been marked stale because it has been open for 60 days with no activity.