[Build] Add README to public NuGet Packages
Open
Nobody has claimed this yet.
area-Build
- Dominant language
- C#
- Stars
- 7.8k
- Forks
- 1.2k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 49
Description
Is your feature request related to a problem? Please describe.
Our build Stride.sln process is logging around 60 messages for missing readme file.
Code File Line Column
24>The package Stride.Core.ProjectTemplating.4.2.0.1 is missing a readme.
Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 763 81
Describe the solution you'd like
We should create a template which would be used for all our NuGet packages, also important NuGet packages could have unique readme files. This might help with discoverability of Stride project itself, as we can provide important links in the readme and drive traffic to our project from all NuGet packages.
https://learn.microsoft.com/en-us/nuget/create-packages/package-authoring-best-practices#readme
- Add description, example:
<Description>Core assembly for all Stride assemblies.</Description> - Add README as recommended
Describe alternatives you've considered
No ideal but suppressig these messages.
Additional context
Full list:
6>The package Stride.Irony.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 186 63
5>The package Stride.Core.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 192 62
8>The package Stride.Core.IO.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 255 65
9>The package Stride.Core.MicroThreading.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 265 77
10>The package Stride.Core.Mathematics.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 268 75
7>The package Stride.Core.Translation.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 271 74
11>The package Stride.Core.Shaders.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 277 71
14>The package Stride.Core.Translation.Presentation.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 284 88
12>The package Stride.Core.Serialization.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 318 77
15>The package Stride.Core.Reflection.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 393 74
16>The package Stride.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 455 58
17>The package Stride.Core.Yaml.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 472 68
13>The package Stride.Native.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 490 65
18>The package Stride.Shaders.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 525 66
19>The package Stride.Core.Design.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 534 70
26>The package Stride.Core.BuildEngine.Common.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 619 82
22>The package Stride.Core.Presentation.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 622 76
25>The package Stride.Core.Quantum.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 647 71
21>The package Stride.Shaders.Parser.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 756 73
20>The package Stride.Audio.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 759 64
27>The package Stride.Core.Presentation.Wpf.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 767 80
28>The package Stride.Core.Presentation.Quantum.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 787 84
23>The package Stride.Core.Packages.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 796 72
29>The package Stride.Shaders.Compiler.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 814 75
31>The package Stride.Core.Presentation.Dialogs.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 832 84
30>The package Stride.Core.Presentation.Graph.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 836 82
32>The package Stride.Core.Assets.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 864 70
33>The package Stride.Core.Tasks.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 912 69
34>The package Stride.Core.Assets.Quantum.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 917 78
35>The package Stride.Samples.Templates.4.2.0.2-dev is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 2543 80
37>The package Stride.Core.Assets.Editor.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 2558 77
36>The package Stride.Graphics.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 2579 67
40>The package Stride.Games.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 2749 64
38>The package Stride.Graphics.RenderDocPlugin.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 2753 83
39>The package Stride.TextureConverter.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 2832 75
42>The package Stride.Input.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 2867 64
41>The package Stride.Rendering.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3293 68
43>The package Stride.VirtualReality.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3357 73
44>The package Stride.Engine.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3472 65
45>The package Stride.BepuPhysics.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3639 70
52>The package Stride.UI.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3642 61
51>The package Stride.Physics.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3657 66
48>The package Stride.Particles.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3671 68
49>The package Stride.SpriteStudio.Runtime.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3678 79
46>The package Stride.Voxels.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3758 65
47>The package Stride.Video.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3760 64
50>The package Stride.ConnectionRouter.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3764 75
53>The package Stride.Navigation.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3793 69
54>The package Stride.Assets.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3919 65
55>The package Stride.Importer.Common.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3971 74
58>The package Stride.Debugger.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 3989 67
57>The package Stride.EffectCompilerServer.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 4011 79
59>The package Stride.Importer.3D.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 4027 70
60>The package Stride.Assets.Models.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 4064 72
56>The package Stride.SpriteStudio.Offline.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 4072 79
61>The package Stride.Core.Assets.CompilerApp.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 4096 82
62>The package Stride.Editor.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 4141 65
63>The package Stride.Assets.Presentation.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 4509 78
64>The package Stride.GameStudio.4.2.0.1 is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important. 4559 69
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the packaging configuration used by Stride.sln and how the listed public packages receive their metadata. Define the shared README template and any package-specific content, then verify that the packages include descriptions and README files and that the build no longer reports missing-readme messages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100