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

Update Code Section Format in Readme #4272

Open
Jordin221 opened this issue Jul 31, 2024 · 1 comment
Open

Update Code Section Format in Readme #4272

Jordin221 opened this issue Jul 31, 2024 · 1 comment
Labels
kind/docs Improvements or additions to documentation

Comments

@Jordin221
Copy link
Contributor

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. :)

@Jordin221 Jordin221 added the kind/bug Something isn't working label Jul 31, 2024
@lelia
Copy link
Contributor

lelia commented Aug 30, 2024

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! 🙂

@lelia lelia added kind/docs Improvements or additions to documentation and removed kind/bug Something isn't working labels Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants