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

Missing package README file #48392

Open
1 task done
mckennabarlow opened this issue May 23, 2023 · 6 comments
Open
1 task done

Missing package README file #48392

mckennabarlow opened this issue May 23, 2023 · 6 comments
Labels
area-identity Includes: Identity and providers area-middleware area-runtime Includes: Azure, Caching, Middleware, Websockets, Kestrel, IIS, ANCM, HttpAbstractions area-security Includes: Security, OAuth, OIDC task
Milestone

Comments

@mckennabarlow
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

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

@dotnet-issue-labeler dotnet-issue-labeler bot added the area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework label May 23, 2023
@Tratcher Tratcher added area-security Includes: Security, OAuth, OIDC and removed area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework labels May 23, 2023
@Tratcher

This comment has been hidden.

@Tratcher Tratcher added area-runtime Includes: Azure, Caching, Middleware, Websockets, Kestrel, IIS, ANCM, HttpAbstractions area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework labels May 23, 2023
@amcasey
Copy link
Member

amcasey commented May 24, 2023

FYI @halter73 for auth.

@mkArtakMSFT mkArtakMSFT added task and removed area-infrastructure Includes: MSBuild projects/targets, build scripts, CI, Installers and shared framework area-runtime Includes: Azure, Caching, Middleware, Websockets, Kestrel, IIS, ANCM, HttpAbstractions labels May 24, 2023
@mkArtakMSFT mkArtakMSFT added this to the 8.0-rc2 milestone May 24, 2023
@halter73
Copy link
Member

Is area-security the best label for this? I'm not sure it makes sense if it includes adding READMEs to other packages like Microsoft.AspNetCore.Mvc.NewtonsoftJson. Is @Tratcher's list comprehensive?

Do we have a good label for general packaging cleanup? area-infrastructure? @mkArtakMSFT

@Tratcher
Copy link
Member

I know there are a bunch of other packages, I just wasn't sure the best way to get a comprehensive list.

@mckennabarlow
Copy link
Author

mckennabarlow commented Jun 19, 2023

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.

Package Name Package Version Status Done
ajaxcontroltoolkit 20.1.0
dotnet-ef 7.0.4
entityframework 6.4.4
jquery 3.6.4
microsoft.aspnet.identity.core 2.2.3 obsolete
microsoft.aspnet.identity.entityframework 2.2.3 obsolete
microsoft.aspnet.identity.owin 2.2.3 obsolete
microsoft.aspnet.mvc 5.2.9
microsoft.aspnet.signalr 2.4.3
microsoft.aspnet.signalr.core 2.4.3
microsoft.aspnet.web.optimization 1.1.3
microsoft.aspnet.webapi 5.2.9
microsoft.aspnet.webapi.client 5.2.9
microsoft.aspnet.webapi.core 5.2.9
microsoft.aspnet.webapi.cors 5.2.9
microsoft.aspnetcore 2.2.0 obsolete
microsoft.aspnetcore.app 2.2.8 obsolete
microsoft.aspnetcore.app.ref 7.0.4
microsoft.aspnetcore.authentication 2.2.0 obsolete
microsoft.aspnetcore.authentication.google 7.0.4
microsoft.aspnetcore.authentication.jwtbearer 7.0.4
microsoft.aspnetcore.authentication.negotiate 7.0.4
microsoft.aspnetcore.authentication.openidconnect 7.0.4
microsoft.aspnetcore.components.authorization 7.0.4
microsoft.aspnetcore.components.webassembly 7.0.4
microsoft.aspnetcore.cors 2.2.0 obsolete
microsoft.aspnetcore.diagnostics.entityframeworkcore 7.0.4
microsoft.aspnetcore.hosting 2.2.7 obsolete
microsoft.aspnetcore.http 2.2.2 obsolete
microsoft.aspnetcore.http.abstractions 2.2.0 obsolete
microsoft.aspnetcore.http.extensions 2.2.0 obsolete
microsoft.aspnetcore.http.features 5.0.17
microsoft.aspnetcore.identity 2.2.0 obsolete
microsoft.aspnetcore.identity.entityframeworkcore 7.0.4
microsoft.aspnetcore.identity.ui 7.0.4
microsoft.aspnetcore.mvc 2.2.0 obsolete
microsoft.aspnetcore.mvc.core 2.2.5 obsolete
microsoft.aspnetcore.mvc.newtonsoftjson 7.0.4
microsoft.aspnetcore.mvc.razor.runtimecompilation 7.0.4
microsoft.aspnetcore.mvc.testing 7.0.4
microsoft.aspnetcore.openapi 7.0.4
microsoft.aspnetcore.session 2.2.0 obsolete
microsoft.aspnetcore.signalr 1.1.0
microsoft.aspnetcore.signalr.client 7.0.4
microsoft.aspnetcore.spaservices.extensions 7.0.4
microsoft.aspnetcore.staticfiles 2.2.0 obsolete
microsoft.aspnetcore.testhost 7.0.4
microsoft.codedom.providers.dotnetcompilerplatform 3.6.0
microsoft.data.sqlite 7.0.4
microsoft.data.sqlite.core 7.0.4
microsoft.entityframeworkcore 7.0.4
microsoft.entityframeworkcore.abstractions 7.0.4
microsoft.entityframeworkcore.analyzers 7.0.4
microsoft.entityframeworkcore.design 7.0.4
microsoft.entityframeworkcore.inmemory 7.0.4
microsoft.entityframeworkcore.proxies 7.0.4
microsoft.entityframeworkcore.relational 7.0.4
microsoft.entityframeworkcore.sqlite 7.0.4
microsoft.entityframeworkcore.sqlite.core 7.0.4
microsoft.entityframeworkcore.sqlserver 7.0.4
microsoft.entityframeworkcore.sqlserver.design 1.1.6
microsoft.entityframeworkcore.tools 7.0.4
microsoft.entityframeworkcore.tools.dotnet 2.0.3
microsoft.extensions.caching.memory 7.0.0
microsoft.extensions.configuration 7.0.0
microsoft.extensions.configuration.abstractions 7.0.0
microsoft.extensions.configuration.binder 7.0.4
microsoft.extensions.configuration.environmentvariables 7.0.0
microsoft.extensions.configuration.fileextensions 7.0.0
microsoft.extensions.configuration.json 7.0.0
microsoft.extensions.configuration.usersecrets 7.0.0
microsoft.extensions.dependencyinjection 7.0.0
microsoft.extensions.dependencyinjection.abstractions 7.0.0
microsoft.extensions.hosting 7.0.1
microsoft.extensions.hosting.abstractions 7.0.0
microsoft.extensions.hosting.windowsservices 7.0.0
microsoft.extensions.http 7.0.0
microsoft.extensions.http.polly 7.0.4
microsoft.extensions.logging 7.0.0
microsoft.extensions.logging.abstractions 7.0.0
microsoft.extensions.logging.console 7.0.0
microsoft.extensions.options 7.0.1
microsoft.extensions.options.configurationextensions 7.0.0
microsoft.jquery.unobtrusive.ajax 3.2.6
microsoft.owin 4.2.2
microsoft.owin.host.systemweb 4.2.2
microsoft.owin.security.cookies 4.2.2
microsoft.owin.security.oauth 4.2.2
microsoft.visualstudio.web.codegeneration.design 7.0.5
system.componentmodel.annotations 5.0.0
system.io.compression.zipfile 4.3.0
system.net.http 4.3.4
system.servicemodel.http 4.10.2
system.servicemodel.primitives 4.10.2
system.text.encoding.codepages 7.0.0

@Tratcher Tratcher removed the area-security Includes: Security, OAuth, OIDC label Jun 19, 2023
@Tratcher
Copy link
Member

TODO:

@Tratcher Tratcher added area-security Includes: Security, OAuth, OIDC area-runtime Includes: Azure, Caching, Middleware, Websockets, Kestrel, IIS, ANCM, HttpAbstractions area-identity Includes: Identity and providers area-middleware labels Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-identity Includes: Identity and providers area-middleware area-runtime Includes: Azure, Caching, Middleware, Websockets, Kestrel, IIS, ANCM, HttpAbstractions area-security Includes: Security, OAuth, OIDC task
Projects
None yet
Development

No branches or pull requests

6 participants
@halter73 @Tratcher @amcasey @mckennabarlow @mkArtakMSFT and others