tooling(srctl): add README describing purpose and usage

[Pnkcaht]

What I did

• Added a README to the sig-security-tooling/srctl directory
• Documented the background and motivation for the creation of srctl
• Described its intended users and high-level functionality
• Provided context on how the tool fits into the CVE publication workflow

Related issues

• Fixes tooling: add a README.md to sig-security-tooling/srctl #176

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Pnkcaht
Once this PR has been reviewed and has the lgtm label, please assign tabbysable for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• sig-security-tooling/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[k8s-ci-robot]

Welcome @Pnkcaht!

It looks like this is your first PR to kubernetes/sig-security 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/sig-security has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @Pnkcaht. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[PushkarJ]

/ok-to-test
/sig security docs

[mtardy]

Hey thanks for taking the time to do this but I feel overall we could really improve this README, the information is repeated multiple times, it sounds quite diluted. I don't think it's useful under this form.

I don't know if you generated this using AI and my initial issue but I feel it would be better if you tried to do this manually. Writing a concise and information dense README would be appropriate for this.

Quickly being able to understand, what is this tool, what problem it solves exactly, for who, and how to use it in 5min maybe showing outputs and command line interaction would be better than this.

[mtardy]

could you remove this line, it's only for SRC people, but this is not the only problem, see the general feedback

[mtardy]

could you remove the --- in the doc?

[mtardy]

Could you wrap all lines to 80 chars approx, that makes review easier, you can use vim with gq for that

[mtardy]

I see from your GitHub profile that you have been opening a lot of PRs in various repositories and organizations on the same day. I understand why you may be excited that AI can multiply your impact but I'd suggest focusing on smaller subset of tasks and trying to propose actual good contributions. Blasting projects with contributions like that really doesn't help imho.

Most of the time when we open good-first-issues like that, it's not because we want this specific task to be solved but to encourage someone from stepping up and build a long-term contributor relationship. It's often something that would have be quicker to do by our own.

[Pnkcaht]

I see from your GitHub profile that you have been opening a lot of PRs in various repositories and organizations on the same day. I understand why you may be excited that AI can multiply your impact but I'd suggest focusing on smaller subset of tasks and trying to propose actual good contributions. Blasting projects with contributions like that really doesn't help imho.

Most of the time when we open good-first-issues like that, it's not because we want this specific task to be solved but to encourage someone from stepping up and build a long-term contributor relationship. It's often something that would have be quicker to do by our own.

I understand, I don't judge. In fact, I work in the Docker and Grafana ecosystem, and my PRs range from small to large, without errors. But I confess that in Kubernetes I used AI to facilitate and accelerate the process, even knowing that AI makes mistakes (and that's what happened). I will correct the problems and do it the same way I do in Docker and Grafana.