-
Notifications
You must be signed in to change notification settings - Fork 337
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
autofixture is missing NuGet package README file #1439
Comments
Sorry for noise. autofixture and autofixture.automoq packages are top installed packages on NuGet.org. Appreciate to include readme for those packages. it really helps customers get started with your packages. Our customer research indicates that one of the top problems that package consumers face is insufficient package documentation such as README files. Adding a README file to your package will help users quickly understand what the package is and what it does. |
@lyndaidaii no worries, I understand this is just a distribution message for everyone. 😅 |
Hey @aivascu @lyndaidaii, before start working on this, does this mean the current readme should be included or should the current readme also be adapted? thanks in advance. |
@MO2k4 the readme should be adapted to present a overview of the features included in each package, with links (if available) to other relevant documentation. A lot like the readme included in npm packages. |
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: