Skip to content

Commit 9ddb731

Browse files
Update Package readme guidelines with new template (#90842)
* Update package readme guidelines * Fix typo
1 parent f8c110b commit 9ddb731

File tree

2 files changed

+40
-4
lines changed

2 files changed

+40
-4
lines changed

docs/coding-guidelines/libraries-packaging.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,47 @@ Packages can include a Markdown Readme file with a short usage documentation. To
5555
The package Readme is displayed on the package details page on [NuGet gallery](https://nuget.org/). You can include the following content in it:
5656

5757
- A description of the package purpose.
58+
- A list of package key features
59+
- A code example that demostrates how to use the package.
5860
- Information when package should be used. For example, if the library is included in the shared framework in .NET, but needs to be installed via NuGet on .NET Framework, it should be mentioned.
59-
- Information on how to get started with the package.
60-
- Links to related documentation.
6161
- A list of common entry-point types for the package, with links to their API docs under [.NET API Browser](https://learn.microsoft.com/dotnet/api/).
62-
- A short code example that demostrates the package usage.
62+
- Links to related documentation.
63+
- Information about how to provide feedback on the package and contribute to it.
64+
65+
Use the following Markdown template for a package Readme:
66+
67+
```
68+
## About
69+
70+
<!-- A description of the package and where one can find more documentation -->
71+
72+
## Key Features
73+
74+
<!-- The key features of this package -->
75+
76+
## How to Use
77+
78+
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
79+
80+
## Main Types
81+
82+
<!-- The main types provided in this library -->
83+
84+
## Additional Documentation
85+
86+
* [Conceptual documentation](...)
87+
* [API documentation](...)
88+
89+
## Related Packages
90+
91+
<!-- The related packages associated with this package -->
92+
93+
## Feedback & Contributing
94+
95+
<!-- How to provide feedback on this package and contribute to it -->
96+
97+
ExamplePackage is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
98+
```
6399

64100
For a list of supported Markdown features, see [NuGet documentation](https://learn.microsoft.com/nuget/nuget-org/package-readme-on-nuget-org#supported-markdown-features).
65101

src/libraries/System.Text.Json/src/PACKAGE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ The main types provided by this library are:
237237
* `System.Text.Json.Nodes.JsonNode`
238238
* `System.Text.Json.Serialization.Metadata.JsonTypeInfo`
239239

240-
## Addtional Documentation
240+
## Additional Documentation
241241

242242
* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/overview)
243243
* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/system.text.json)

0 commit comments

Comments
 (0)