Skip to content
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

Open
lyndaidaii opened this issue Feb 9, 2024 · 2 comments
Open

autofixture is missing NuGet package README file #1439

lyndaidaii opened this issue Feb 9, 2024 · 2 comments
Milestone

Comments

@lyndaidaii
Copy link

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.

@lyndaidaii
Copy link
Author

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.

@aivascu
Copy link
Member

aivascu commented Feb 9, 2024

@lyndaidaii no worries, I understand this is just a distribution message for everyone. 😅
This is not high priority at the moment but I'll try to get one in soon.
Just in case you're collecting feedback, Microsoft might help documentation of .NET projects if DocFx will get more attention/funding. :)

@aivascu aivascu added this to the v5.0 milestone Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants