From 7dc1f6febc3472958244f466329b625bf5e1572b Mon Sep 17 00:00:00 2001
From: "MSDN.WhiteKnight" <35516665+MSDN-WhiteKnight@users.noreply.github.com>
Date: Mon, 21 Aug 2023 15:44:18 +0500
Subject: [PATCH] Update Package readme guidelines with new template (#90842)

* Update package readme guidelines

* Fix typo
---
 docs/coding-guidelines/libraries-packaging.md | 42 +++++++++++++++++++++++++--
 src/libraries/System.Text.Json/src/PACKAGE.md |  2 +-
 2 files changed, 40 insertions(+), 4 deletions(-)

diff --git a/docs/coding-guidelines/libraries-packaging.md b/docs/coding-guidelines/libraries-packaging.md
index 25a2894..f7c9268 100644
--- a/docs/coding-guidelines/libraries-packaging.md
+++ b/docs/coding-guidelines/libraries-packaging.md
@@ -55,11 +55,47 @@ Packages can include a Markdown Readme file with a short usage documentation. To
 The package Readme is displayed on the package details page on [NuGet gallery](https://nuget.org/). You can include the following content in it:
 
 - A description of the package purpose.
+- A list of package key features
+- A code example that demostrates how to use the package.
 - 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.
-- Information on how to get started with the package.
-- Links to related documentation.
 - 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/).
-- A short code example that demostrates the package usage.
+- Links to related documentation.
+- Information about how to provide feedback on the package and contribute to it.
+
+Use the following Markdown template for a package Readme:
+
+```
+## About
+
+<!-- A description of the package and where one can find more documentation -->
+
+## Key Features
+
+<!-- The key features of this package -->
+
+## How to Use
+
+<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
+
+## Main Types
+
+<!-- The main types provided in this library -->
+
+## Additional Documentation
+
+* [Conceptual documentation](...)
+* [API documentation](...)
+
+## Related Packages
+
+<!-- The related packages associated with this package -->
+
+## Feedback & Contributing
+
+<!-- How to provide feedback on this package and contribute to it -->
+
+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).
+```
 
 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).
 
diff --git a/src/libraries/System.Text.Json/src/PACKAGE.md b/src/libraries/System.Text.Json/src/PACKAGE.md
index 1bfcd1d..7cbbec7 100644
--- a/src/libraries/System.Text.Json/src/PACKAGE.md
+++ b/src/libraries/System.Text.Json/src/PACKAGE.md
@@ -237,7 +237,7 @@ The main types provided by this library are:
 * `System.Text.Json.Nodes.JsonNode`
 * `System.Text.Json.Serialization.Metadata.JsonTypeInfo`
 
-## Addtional Documentation
+## Additional Documentation
 
 * [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/overview)
 * [API documentation](https://learn.microsoft.com/en-us/dotnet/api/system.text.json)
-- 
2.7.4