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
Missing package README file #48392
Comments
This comment has been hidden.
This comment has been hidden.
|
FYI @halter73 for auth. |
|
Is Do we have a good label for general packaging cleanup? |
|
I know there are a bunch of other packages, I just wasn't sure the best way to get a comprehensive list. |
|
Hi there, these are the packages owned by aspnet that I have as lacking a README file. I know this is a super long list -- let me know how I can best assist your team in addressing these missing files.
|
|
TODO:
|
Is there an existing issue for this?
Is your feature request related to a problem? Please describe the problem.
As one of the top most installed NuGet packages, your Microsoft.AspNetCore.Authentication.JwtBearer package is extremely important to the developer ecosystem. The NuGet team has noticed that your package on NuGet.org is missing a README file.
Please take a moment to add a README file to your package repository.
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. Since your README will be the first impression for users when they view your package on NuGet.org, it is crucial for authors to write and include high-quality READMEs for their packages.
Describe the solution you'd like
Please add a README file to your package so that users can understand at a glance what the package contains and how to use it.
There is no specific format or structure to a good README – instead it’s about effectively communicating the purpose and functionality of your package to potential users. If you are unsure of where to start, check out our blog post for some README best practices and a template file.
If you are new to NuGet README, learn more about how to add a README to your NuGet Package.
Additional context
Your feedback is very important to us. If you experience any issue using READMEs or have ideas for improvements – please feel free to contact us by replying to this issue
The text was updated successfully, but these errors were encountered: