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

docs(osv-linter): Add a README.md #304

Merged
merged 2 commits into from
Nov 5, 2024

Conversation

andrewpollock
Copy link
Collaborator

This commit adds a README.md to provide interested parties with some further details and guidance about the OSV linter

This commit adds a README.md to provide interested parties with some
further details and guidance about the OSV linter
Signed-off-by: Andrew Pollock <[email protected]>

Signed-off-by: Andrew Pollock <[email protected]>
@andrewpollock
Copy link
Collaborator Author

@hogo6002 could you please also take a look at this and see how it reads for you as someone new to this?

@andrewpollock
Copy link
Collaborator Author

@darakian I'd appreciate your perspective on the readability of this, if you have time

@hogo6002
Copy link
Contributor

@hogo6002 could you please also take a look at this and see how it reads for you as someone new to this?

LGTM! The Usage and Contributing sections are very helpful for new contributors like me.

@andrewpollock
Copy link
Collaborator Author

@oliverchang I'd like to get this merged today, so any feedback from @darakian I'll act on in a follow-up PR.

@darakian
Copy link
Contributor

Looks quite readable to me, but two things come to mind

  1. Install instructions would be nice. I know clone & compile is implicit given that it's a git repo , but if the go get <url> method of installation works then I would call that out specifically. If it doesn't work then getting it to work would be nice :)
  2. Breaking the checks out into their own section with some prose describing what they do would be nice. Maybe more relevant once there are more than six checks.

Copy link
Contributor

@oliverchang oliverchang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apologies, missed your earlier comment @andrewpollock!

@andrewpollock andrewpollock merged commit bf7ac4d into ossf:main Nov 5, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants