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

exiled is missing NuGet package README file #2447

Closed
lyndaidaii opened this issue Feb 9, 2024 · 4 comments
Closed

exiled is missing NuGet package README file #2447

lyndaidaii opened this issue Feb 9, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

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.

@louis1706 louis1706 added the documentation Improvements or additions to documentation label Feb 10, 2024
@NaoUnderscore
Copy link
Collaborator

Absolutely, we appreciate the reminder.

We'll ensure to add the README file promptly to provide users with a clear understanding of our package's purpose and functionality.

Thank you for bringing this to our attention.

@lyndaidaii
Copy link
Author

Thank you for doing it. your packages are top installed packages on NuGet.org.

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. It will really help customers to get started with your packages.

Thanks again!

@ALEXWARELLC
Copy link
Member

Interesting seeing a Microsoft employee here of all places. Good to see attention to semi-small scaling projects.

@ALEXWARELLC
Copy link
Member

@NaoUnderscore What's happening with this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants