-
-
Notifications
You must be signed in to change notification settings - Fork 945
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.
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
benchmarkdotnet is missing NuGet package README file #2519
Comments
@lyndaidaii thanks for creating this issue! Adding README to the NuGet package is in my backlog list. However, instead of having a standalone file, I want to reuse the repository README.md with some postprocessing updates. Most of the preparation steps are already finished and we are almost ready to include it in our NuGet publishing pipeline. However, I want to finish some documentation updates first so that the README is less wordy and more useful. At the moment, I'm working on it in the background, but it's a low-priority activity, so no ETA for now. |
We've noticed that your package on NuGet.org is missing a README file.
Why READMEs are Important
A README is essential for users to understand your package's purpose and functionality quickly. It's the first thing users see on NuGet.org and helps them decide if your package meets their needs.
Get Started with READMEs
How to Add a README
If you're new to NuGet READMEs, follow guidance on how to add one to your package.
How to write high quality of READMEs
Follow a blog post with README best practices and a template file to help you get started.
We Value Your Feedback
We value your feedback. If you encounter any issues or have suggestions, please reply to this issue.
Thank you for your contribution to the NuGet community.
The text was updated successfully, but these errors were encountered: