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.

Sign up for GitHub

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

Jump to bottom

docs: update options list in README.md #3652

Closed
terriko opened this issue Dec 20, 2023 · 2 comments · Fixed by #3662
Closed

docs: update options list in README.md #3652

terriko opened this issue Dec 20, 2023 · 2 comments · Fixed by #3662
Assignees
@DEVESH-N2
Labels
documentation Documentation changes good first issue Good for newcomers
Milestone
3.3

Comments

@terriko
Copy link
Contributor

terriko commented Dec 20, 2023

At the bottom of the README.md file is a list of cve-bin-tool's options:

https://github.com/intel/cve-bin-tool#full-option-list

In preparation for the 3.3 release, we should double-check that the text there and what you get when you do cve-bin-tool --help are the same text. In addition, there's a few options that are missing links to the MANUAL file or our readthedocs documentation. It would be good to get those links added where they are missing. Be aware that some of the options have characters in them that need to be escaped correctly when linked (there should be ample examples in the existing README to help you figure it out)

This should be suitable for a new contributor, so here's the new contributor tips:

Short tips for new contributors:

  • cve-bin-tool's contributor docs
  • If you've contributed to open source but not this project, you might just want our checklist for a great pull request
  • cve-bin-tool uses https://www.conventionalcommits.org/ style for commit messages, and we have a test that checks the title of your pull request (PR). A good potential title for this one is in the title of this issue.
  • You can make an issue auto close by including a comment "fixes #ISSUENUMBER" in your PR comments where ISSUENUMBER is the actual number of the issue. This "links" the issue to the pull request.

Claiming issues:

  • You do not need to have an issue assigned to you before you work on it. To "claim" an issue either make a linked pull request or comment on the issue saying you'll be working on it.
  • If someone else has already commented or opened a pull request, assume it is claimed and find another issue to work on.
  • If it's been more than 1 week without progress, you can ask in a comment if the claimant is still working on it before claiming it yourself (give them at least 3 days to respond before assuming they have moved on).
@terriko terriko added good first issue Good for newcomers documentation Documentation changes labels Dec 20, 2023
@terriko terriko added this to the 3.3 milestone Dec 20, 2023
@DEVESH-N2
Copy link
Contributor

@terriko I am a new contributor, I would like to work on it

@terriko
Copy link
Contributor Author

terriko commented Dec 20, 2023

@DEVESH-N2 have fun and let us know if you have any questions!

@DEVESH-N2 DEVESH-N2 mentioned this issue Dec 22, 2023
Merged
terriko pushed a commit that referenced this issue Jan 4, 2024
@DEVESH-N2
docs(README.md): updated options list in README.md (#3662)
7862103 
I have updated the options list in README.md by adding the missing options which I got from cve-bin-tool --help . Also I have added the links to the MANUAL file for the options which were present in the MANUAL file. Few of the options were not present in the MANUAL file, so I couldn't add the links for those options.

fixes #3652
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DEVESH-N2 DEVESH-N2

Labels
documentation Documentation changes good first issue Good for newcomers
Projects
None yet
Milestone
3.3
Development

Successfully merging a pull request may close this issue.

docs(README.md): updated options list in README.md DEVESH-N2/cve-bin-tool
2 participants
@terriko @DEVESH-N2