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

NuGet - Add README file #4713

Open
lyndaidaii opened this issue Feb 9, 2024 · 1 comment
Open

NuGet - Add README file #4713

lyndaidaii opened this issue Feb 9, 2024 · 1 comment
Labels
Good First Issue good first issue Issues that are suitable for first-time contributors. Help Wanted up-for-grabs

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

Here is list of packages that are top installed in NuGet.org:
cefsharp.winforms
cefsharp.wpf
cefsharp.winforms.netcore
cefsharp.wpf.netcore
cefsharp.common.netcore

Appreciate if you could include README for your mapster packages, it is top installed packages on NuGet.org. It really helps customers to 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.

@amaitland amaitland changed the title cefsharp.wpf is missing NuGet package README file NuGet - Add README file Feb 16, 2024
@amaitland amaitland added up-for-grabs Good First Issue good first issue Issues that are suitable for first-time contributors. Help Wanted labels Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue good first issue Issues that are suitable for first-time contributors. Help Wanted up-for-grabs
Projects
None yet
Development

No branches or pull requests

2 participants