From 79056d0b3c4a73c6cfd849fd09d0f177d3c9cc74 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= <michael@hompus.nl>
Date: Wed, 21 Aug 2024 22:53:14 +0200
Subject: [PATCH 1/2] Provide System.Composition.Convention package readme

---
 .../src/PACKAGE.md                            | 96 +++++++++++++++++++
 .../src/System.Composition.Convention.csproj  | 11 +--
 2 files changed, 97 insertions(+), 10 deletions(-)
 create mode 100644 src/libraries/System.Composition.Convention/src/PACKAGE.md

diff --git a/src/libraries/System.Composition.Convention/src/PACKAGE.md b/src/libraries/System.Composition.Convention/src/PACKAGE.md
new file mode 100644
index 00000000000000..b149e253357fb4
--- /dev/null
+++ b/src/libraries/System.Composition.Convention/src/PACKAGE.md
@@ -0,0 +1,96 @@
+## About
+
+<!-- A description of the package and where one can find more documentation -->
+
+`System.Composition.Convention` is part of the Managed Extensibility Framework (MEF) 2.0, a composition library for .NET that enables dependency injection through attributes.
+
+This package simplifies the process of applying consistent patterns for part exports, imports, and metadata by using convention-based configurations.
+It is useful for scenarios where you want to avoid repetitive attribute-based decoration and instead define conventions for registering types in your composition container.
+
+## Key Features
+
+<!-- The key features of this package -->
+
+* Configure exports, imports, and metadata for parts using conventions rather than attributes.
+* Allows defining conventions through a fluent API, making configuration more flexible and readable.
+
+## 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 -->
+
+Configure parts for composition without using attributes.
+
+```csharp
+using System.Composition.Convention;
+using System.Composition.Hosting;
+
+var conventions = new ConventionBuilder();
+
+// Apply conventions: any class that implements ILogger will be exported as ILogger
+conventions
+    .ForTypesDerivedFrom<ILogger>()
+    .Export<ILogger>();
+
+var configuration = new ContainerConfiguration()
+    .WithPart<FileLogger>(conventions)
+    .WithPart<ConsoleLogger>(conventions);
+
+using CompositionHost container = configuration.CreateContainer();
+    
+var loggers = container.GetExports<ILogger>();
+
+foreach (var logger in loggers)
+{
+    logger.Log("Hello, World!");
+}
+// FileLogger: Hello, World!
+// ConsoleLogger: Hello, World!
+
+public interface ILogger
+{
+    void Log(string message);
+}
+
+public class FileLogger : ILogger
+{
+    public void Log(string message) => Console.WriteLine($"FileLogger: {message}");
+}
+
+public class ConsoleLogger : ILogger
+{
+    public void Log(string message) => Console.WriteLine($"ConsoleLogger: {message}");
+}
+```
+
+## Main Types
+
+<!-- The main types provided in this library -->
+
+The main types provided by this library are:
+
+* `System.Composition.Convention.ConventionBuilder`
+* `System.Composition.Convention.PartConventionBuilder`
+* `System.Composition.Convention.ParameterImportConventionBuilder`
+
+## Additional Documentation
+
+<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
+
+* [API documentation](https://learn.microsoft.com/dotnet/api/system.composition.convention)
+* [Managed Extensibility Framework (MEF)](https://learn.microsoft.com/dotnet/framework/mef/)
+
+## Related Packages
+
+<!-- The related packages associated with this package -->
+
+* [System.Composition.AttributedModel](https://www.nuget.org/packages/System.Composition.AttributedModel)
+* [System.Composition.Hosting](https://www.nuget.org/packages/System.Composition.Hosting)
+* [System.Composition.Runtime](https://www.nuget.org/packages/System.Composition.Runtime)
+* [System.Composition.TypedParts](https://www.nuget.org/packages/System.Composition.TypedParts)
+
+## Feedback & Contributing
+
+<!-- How to provide feedback on this package and contribute to it -->
+
+System.Composition.Convention 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).
diff --git a/src/libraries/System.Composition.Convention/src/System.Composition.Convention.csproj b/src/libraries/System.Composition.Convention/src/System.Composition.Convention.csproj
index 8e1f44ee3df72d..2544944eec76ea 100644
--- a/src/libraries/System.Composition.Convention/src/System.Composition.Convention.csproj
+++ b/src/libraries/System.Composition.Convention/src/System.Composition.Convention.csproj
@@ -6,19 +6,10 @@
     <StrongNameKeyId>Microsoft</StrongNameKeyId>
     <UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile>
     <IsPackable>true</IsPackable>
-    <PackageDescription>Provides types that support using Managed Extensibility Framework with a convention-based configuration model.
-
-Commonly Used Types:
-System.Composition.Convention.ConventionBuilder
-System.Composition.Convention.ExportConventionBuilder
-System.Composition.Convention.ImportConventionBuilder
-System.Composition.Convention.PartConventionBuilder
-System.Composition.Convention.ParameterImportConventionBuilder</PackageDescription>
+    <PackageDescription>Provides types that support using Managed Extensibility Framework (MEF) with a convention-based configuration model.</PackageDescription>
     <!-- TODO https://github.com/dotnet/runtime/issues/90400: Annotate for nullable reference types -->
     <Nullable>disable</Nullable>
     <NoWarn>$(NoWarn);nullable</NoWarn>
-    <!-- TODO: Add package README file: https://github.com/dotnet/runtime/issues/99358 -->
-    <EnableDefaultPackageReadmeFile>false</EnableDefaultPackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>

From ebd2bbf35acda4830ba3ec3d2280c4cea4ad7909 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= <michael@hompus.nl>
Date: Mon, 26 Aug 2024 18:09:17 +0200
Subject: [PATCH 2/2] Improve after feedback

---
 src/libraries/System.Composition.Convention/src/PACKAGE.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/libraries/System.Composition.Convention/src/PACKAGE.md b/src/libraries/System.Composition.Convention/src/PACKAGE.md
index b149e253357fb4..4f6e1fdc2358cf 100644
--- a/src/libraries/System.Composition.Convention/src/PACKAGE.md
+++ b/src/libraries/System.Composition.Convention/src/PACKAGE.md
@@ -2,7 +2,7 @@
 
 <!-- A description of the package and where one can find more documentation -->
 
-`System.Composition.Convention` is part of the Managed Extensibility Framework (MEF) 2.0, a composition library for .NET that enables dependency injection through attributes.
+`System.Composition.Convention` is part of the Managed Extensibility Framework (MEF) 2.0, a composition library for .NET that enables dependency injection through attributes or conventions.
 
 This package simplifies the process of applying consistent patterns for part exports, imports, and metadata by using convention-based configurations.
 It is useful for scenarios where you want to avoid repetitive attribute-based decoration and instead define conventions for registering types in your composition container.
@@ -83,6 +83,7 @@ The main types provided by this library are:
 
 <!-- The related packages associated with this package -->
 
+* [System.Composition](https://www.nuget.org/packages/System.Composition)
 * [System.Composition.AttributedModel](https://www.nuget.org/packages/System.Composition.AttributedModel)
 * [System.Composition.Hosting](https://www.nuget.org/packages/System.Composition.Hosting)
 * [System.Composition.Runtime](https://www.nuget.org/packages/System.Composition.Runtime)