Open ViktorHofer opened 8 months ago
Tagging subscribers to this area: @dotnet/area-infrastructure-libraries See info in area-owners.md if you want to be subscribed.
Author: | ViktorHofer |
---|---|
Assignees: | - |
Labels: | `area-Infrastructure-libraries` |
Milestone: | 9.0.0 |
@ViktorHofer https://github.com/dotnet/runtime/pull/106344 for System.Formats.Nrbf
Continuation of https://github.com/dotnet/runtime/pull/91210 & https://github.com/dotnet/runtime/pull/92228
This issue tracks adding the remaining 30 package readmes to our shipping libraries packages.
One of the top customer problems that package consumers are facing is lack of documentation. As such, we are driving an effort to increase the adoption and quality of NuGet package READMEs.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
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 other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This issue lists all the remaining package that are missing package READMEs. Feel free to submit a PR that targets the main branch by using the
NEW
link from the table below. For a great example, please seeSystem.Text.Json
's package README. Expect to spend ~15-30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.Packages
This list is sorted alphabetically.
FWIW I created this table via the following code: https://gist.github.com/ViktorHofer/e4ba1766b7ee751261515781e7bb5927
:white_check_mark: (
:white_check_mark:
) ->merged:clock130: (
:clock130:
) -> under reviewcc @lyndaidaii @ericstj @artl93 @eNeRGy164