-
Notifications
You must be signed in to change notification settings - Fork 4.7k
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
System.Net.Http NuGet Package Missing README File #86667
Comments
The |
Tagging subscribers to this area: @dotnet/area-infrastructure-libraries Issue DetailsIs 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 System.Net.Http 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. Describe the solution you'd likePlease 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. Additional contextYour 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
|
Additionally to what @teo-tsirpanis said, System.Net.Http we currently do not ship it as a nuget package (does not explicitly set @ViktorHofer do we need to take some explicit action about this package, or do we just close the issue? |
Add README to this and other similar obsolete packages? Adding README does not require re-publishing the package: #86661 (comment) |
We discussed this offline a while ago and it was pointed out that README files can be added without republishing the file. Note that the README would go away though if you republish the package. I'm hesitant making a statement here aside from that we can't mark the package as deprecated as it is part of the supported netstandard1.x dependency graph. All that said, @dotnet/ncl has to decide as they own that library and package. |
Tagging subscribers to this area: @dotnet/ncl Issue DetailsIs 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 System.Net.Http 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. Describe the solution you'd likePlease 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. Additional contextYour 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
|
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 System.Net.Http 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: