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

System.Net.Http NuGet Package Missing README File #86667

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

System.Net.Http NuGet Package Missing README File #86667

mckennabarlow opened this issue May 23, 2023 · 6 comments

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 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

@BrennanConroy BrennanConroy transferred this issue from dotnet/aspnetcore May 23, 2023
@dotnet-issue-labeler dotnet-issue-labeler bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label May 23, 2023
@ghost ghost added the untriaged New issue has not been triaged by the area owner label May 23, 2023
@teo-tsirpanis
Copy link
Contributor

The System.Net.Http package is no longer maintained (its latest version was released in 2018) and should be deprecated. Consumers of it should just stop referencing it; the HttpClient APIs are provided inbox on most (or all?) frameworks. Moreover this package also drags dozens of other packages as transitive dependencies, that are equally unnecessary.

@teo-tsirpanis teo-tsirpanis added area-Infrastructure-libraries and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels May 23, 2023
@ghost
Copy link

ghost commented May 23, 2023

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries
See info in area-owners.md if you want to be subscribed.

Issue Details

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 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

Author: mckennabarlow
Assignees: -
Labels:

area-Infrastructure-libraries, untriaged

Milestone: -

@carlossanlop
Copy link
Member

Additionally to what @teo-tsirpanis said, System.Net.Http we currently do not ship it as a nuget package (does not explicitly set IsPackable=true in the csproj) because it is part of the shared framework since .NET Core+ and in .NET 5+ (it's explicitly listed among the in-box packages we ship).

@ViktorHofer do we need to take some explicit action about this package, or do we just close the issue?

@carlossanlop carlossanlop removed the untriaged New issue has not been triaged by the area owner label May 23, 2023
@jkotas
Copy link
Member

jkotas commented May 23, 2023

Add README to this and other similar obsolete packages?

Adding README does not require re-publishing the package: #86661 (comment)

@ViktorHofer
Copy link
Member

ViktorHofer commented May 24, 2023

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.

@ghost
Copy link

ghost commented May 24, 2023

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

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 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

Author: mckennabarlow
Assignees: -
Labels:

area-System.Net.Http

Milestone: -

@ghost ghost added the in-pr There is an active PR which will close this issue when it is merged label Jul 14, 2023
@karelz karelz added this to the 9.0.0 milestone Sep 8, 2023
@ghost ghost removed the in-pr There is an active PR which will close this issue when it is merged label Oct 27, 2023
@MihaZupan MihaZupan modified the milestones: 9.0.0, 8.0.x, Future Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants