-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
Add package readmes to shipping libraries packages #99358
Labels
area-Meta
documentation
Documentation bug or enhancement, does not impact product or test code
help wanted
[up-for-grabs] Good issue for external contributors
Milestone
Comments
Tagging subscribers to this area: @dotnet/area-infrastructure-libraries |
ViktorHofer
added
area-Meta
documentation
Documentation bug or enhancement, does not impact product or test code
help wanted
[up-for-grabs] Good issue for external contributors
and removed
area-Infrastructure-libraries
labels
Mar 11, 2024
This was referenced Mar 13, 2024
This was referenced Aug 12, 2024
@ViktorHofer #106344 for |
This was referenced Aug 14, 2024
This was referenced Aug 21, 2024
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
area-Meta
documentation
Documentation bug or enhancement, does not impact product or test code
help wanted
[up-for-grabs] Good issue for external contributors
Continuation of #91210 & #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:
) ->merged🕜 (
:clock130:
) -> under reviewcc @lyndaidaii @ericstj @artl93 @eNeRGy164
The text was updated successfully, but these errors were encountered: