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

Incorrectly formatted example link #4247

Closed JeremiahAHoward closed 3 months ago

JeremiahAHoward commented 4 months ago

Describe the bug The instructions and link found underneath "View a Project's Score" around line 99 in the README.md can be difficult to interpret. This can be difficult to interpret because the link is coming up as half a hyperlink and the other half just text.

Reproduction steps Steps to reproduce the behavior:

  1. Visit this link to view the relevant section of the README.md: View a Project's Score

Expected behavior The instructions should convey:

  1. There is a link where you can enter a platform/org/repo to view a scorecard
  2. How to manually create a link to view a scorecard

Additional context image

In collaboration with @silasvm, @klbynum, @wavyeli32, @jordin221, and @emmet0r, we would be happy to submit a pull request.

spencerschrock commented 4 months ago

Thanks for the issue and wanting to contribute.

Do you think it would be more clear if it was in markdown backticks?

https://scorecard.dev/viewer/?uri=<github_or_gitlab>.com/<user_name_or_org>/<repository_name>

Wavyeli32 commented 4 months ago

Thank you @spencerschrock! Yes, that is exactly what we were thinking. We also had a few other ideas on how to clarify this section of the documentation and implemented them in a PR to show you what we had in mind. Please let us know what you think. 😊