Some READMEs are outdated (new samples missing)

[tcNickolas]

Here are some examples:

• Root README is missing machine learning category of samples
• README in algorithms is missing repeat-until-success and sudoku-grover
• README in diagnostics is missing dumping and facts-and-assertions
• README in getting-started is missing qrng
• machine-learning folder doesn't have a README

It would also be nice to format README in numerics similar to others, with the list of samples given as a list with links.

[vivekmthr]

Hi! I'd like to try this : ) This would be my first commit. Do you have any reccomendations on where to start?

[cgranade]

@vivekmthr: Thanks for your help! We're still putting together some concrete guidance on how to write good READMEs, but in the meantime, the README for samples/algorithms/chsh-game can be a good place to start, as that README has a lot of what we're hoping to have for new READMEs as well:

• Metadata used to onboard samples to docs.microsoft.com/samples (i.e.: the page_type, language, products, and description keys in the header)
• Metadata used to power the mybinder.org landing page at aka.ms/try-qsharp (i.e.: the jupyter key in the header)
• Brief introduction explaining the sample
• Prerequisites to use the sample
• Instructions on how to run the sample
• List of what each file in the sample is.

When a sample is onboarded to docs.microsoft.com/samples, that README becomes the full description of that sample, such that it's important for a good sample README to be self-contained (e.g.: the chsh-game sample); a user visiting the sample may not have the context of the other samples in this repo.

Thanks for agreeing to take this on, I'm happy to help answer whatever other questions you may have!

[vivekmthr]

Cool! Super excited! I'll get on it tommorow : )

[msoeken]

@vivekmthr Just checking back with you, whether you found some time to look into one of the READMEs? I am happy to help, if I can.

[vivekmthr]

Hey yeah. I'm so sorry, got caught up in exams and stuff. I don't really have much experience with quantum computing, but I'm going to try and spend some time on it today, and update you.

[msoeken]

Thanks @vivekmthr

[buseorak]

Greetings! I would love to work on this issue if it is not assigned to anyone. :)

I have read the requirements above. I have a small question, am I supposed to go through all readme files in the repository and find what needs to be updated or should I only update/create those 6 readme files mentioned in the first comment?

Thank you so much in advance!

[unnati914]

hey! Could i work on this issue if its not assigned to anyone?

[msoeken]

@unnati914 Sure, you can work on this issue. I suggest to just open a PR and mention this issue in there. The PR does not need to address all READMEs but even one or some would be great! Thanks for your interest!

[msoeken]

@buseorak Thanks for offering to work on this issue. The 6 READMEs are just an example, but a good way to start. As mentioned above, simply open a PR and link to this issue. The PR can only contain a single or some READMEs. Thanks for your interest!

[ycechungAI]

its been a month since people replied so i guess i want to work on this issue during HacktoberFest. I am currently taking an open source development class