intel / cve-bin-tool

The CVE Binary Tool helps you determine if your system includes known vulnerabilities. You can scan binaries for over 200 common, vulnerable components (openssl, libpng, libxml2, expat and others), or if you know the components used, you can get a list of known vulnerabilities associated with an SBOM or a list of components and versions.
https://cve-bin-tool.readthedocs.io/en/latest/
GNU General Public License v3.0
1.18k stars 454 forks source link

docs: Add docstrings to parsers #3778

Closed prady0t closed 7 months ago

prady0t commented 7 months ago

Would like to add docstrings to all parsers.

terriko commented 7 months ago

@prady0t There's 11 different parsers. Please just choose one to work on yourself, but feel free to file detailed issues so other people can work on the others.

Because of GSoC we have a lot of people coming in who need at least one PR to go with their application. Since the docstring issues are not urgent, I'm trying reserve them to give more folk a chance at an easy first PR. There's over 100 other issues available to work on if you're bored!

And if you're applying for gsoc, here's a not-so-secret tip: working with you on PRs and issues filed is what we do instead of interviews and coding exercises, so picking up a harder bug, even if you don't solve an issue, working on one in public helps us see how you work more independently and it's a great way to demonstrate your skills in breaking down a problem into steps by yourself, or figuring out more detailed and specific questions that need asking. (I'm completely burned out on "how do I start?" style questions by March so people who've clearly moved past that stage tend to get ranked a lot higher during selection.)

prady0t commented 7 months ago

That makes sense. I'm closing this issue.