Improve help information

cloud-hypervisor / cloud-hypervisor

A Virtual Machine Monitor for modern Cloud workloads. Features include CPU, memory and device hotplug, support for running Windows and Linux guests, device offload with vhost-user and a minimal compact footprint. Written in Rust with a strong focus on security.

https://www.cloudhypervisor.org

3.87k stars 437 forks source link

Improve help information #5551

Open likebreath opened 1 year ago

likebreath commented 1 year ago

We talked about couple of issues around the existing help information in today's community meeting:

[ ] Use path (instead of file) consistently throughout our CLI and REST API
[ ] Simplify the help information via providing top-level information only by default, and subcommand details can be provided with:
- Explicit second-level "--help" command (something like "$ cloud-hypervisor disk --help"), or
- Pointers to related documents

The5cheduler commented 1 year ago

Hey there!

Hope you're doing well. I came across an issue on your project that I'd love to contribute to, but I need a bit more information before diving in. I'm pretty excited about the opportunity to contribute my skills and help out!

Could you provide some additional details about the issue? Specifically, I'd like to know:

What's the scope of the problem or feature that needs attention?
Are there any specific requirements or guidelines for contributing to this project?
Is there any documentation or related resources I should be aware of?

I'm eager to get started and contribute my expertise. Please let me know how I can assist and any additional information you can provide. Looking forward to hearing back from you!

Thanks, The Scheduler

likebreath commented 1 year ago

You should start with our README.md which contains pointers to the resources you asked about.

Task 1 should be fairly straight forward while task 2 has some overlap with #5550.

KshitijKapoor8 commented 5 months ago

Hey! My name is Kshitij and I am a computer science student at the University of Texas at Austin. I am taking a virtualization class this semester, and, as a part of the class, we have to contribute to open source repositories. I came across this project and thought it was really cool, and I would love to be able to contribute. Could you assign this issue to me?