dotnet / dotnet/wcf

System.ServiceModel packages are missing NuGet package README file

Open
#5,238 1 comment 0 reactions 1 assignee Assigned to @mconnew View on GitHub
Dominant language
C#
Stars
1.8k
Forks
576
Avg merge
6d 9h
Merged PRs (30d)
2

Description

We noticed that your NuGet packages are missing a README file and are reaching out to ask you do add a README file to your NuGet package.

- System.ServiceModel.Security
- System.ServiceModel.Duplex
- System.ServiceModel.NetTcp

The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon Visual Studio/Visual Studio Code, it is crucial for package authors to write and include high-quality READMEs for their packages.

To help you get started, we suggest the following steps to include a README in your packages listed below:

• If you are new to NuGet README, learn more about [how to add a README to your NuGet Package](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdevblogs.microsoft.com%2Fnuget%2Fadd-a-readme-to-your-nuget-package%2F&data=05%7C01%7CLynn.Dai%40microsoft.com%7C104a7d575aa945c929e408db97e8d3cf%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638270798485909796%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=0OcAUfiee90eoUxIVEc0FLIh4juGuque56O3lBBdElw%3D&reserved=0).
• Follow the [README template](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fraw.githubusercontent.com%2Flyndaidaii%2FNuGetReadMeTemplate%2Fmain%2FREADME.md&data=05%7C01%7CLynn.Dai%40microsoft.com%7C104a7d575aa945c929e408db97e8d3cf%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638270798485909796%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=XNUA17w6bfKoax%2FSIEAMRQMY%2Fk1E4wEwFzvSDK6M6BA%3D&reserved=0) and [blog post](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdevblogs.microsoft.com%2Fnuget%2Fwrite-a-high-quality-readme-for-nuget-packages%2F&data=05%7C01%7CLynn.Dai%40microsoft.com%7C104a7d575aa945c929e408db97e8d3cf%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638270798485909796%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=VT0JizwK%2B2mk5qz97r5W2NDNS9eRIplqEg%2BOsNab39Q%3D&reserved=0) for best practices.
• Check out a great [example](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fdotnet%2Fruntime%2Fpull%2F90102&data=05%7C01%7CLynn.Dai%40microsoft.com%7C104a7d575aa945c929e408db97e8d3cf%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638270798485909796%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=UbbSUPhoulewaR9S%2BspYeBS8tCYrTKBQKSPjYSxfGCI%3D&reserved=0) README for System.Text.Json that can be used for .NET libraries.
• Reach out to us for review or help.
If you have any questions or need assistance in creating your README, please don't hesitate to reach out.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.