dotnet / dotnet/command-line-api

System.CommandLine is missing NuGet package README file

Aperta
#2,269 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Area-Documentation bug
Lingua principale
C#
Stelle
3.7k
Fork
428
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia esaminando la configurazione del packaging NuGet del repository e la documentazione esistente del progetto per identificare il pacchetto System.CommandLine e l'origine del README. Il lavoro è completato quando il pacchetto include un README utile al momento della pubblicazione su NuGet, seguendo le indicazioni e il modello NuGet collegati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
cli, documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.