Add READMEs and XML documentation to all NuGet packages

Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md

@@ -0,0 +1,13 @@
+Reqnroll.Autofac provides [Autofac](https://github.com/autofac/Autofac) dependency injection integration for Reqnroll.
+
+Plugin supports both registration of dependencies globally and per scenario
+
+## Documentation
+
+For more information about using dependency injection with Reqnroll, see [Autofac - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/autofac.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj

@@ -10,6 +10,8 @@
     <NuspecFile>$(MSBuildThisFileDirectory)Reqnroll.Autofac.nuspec</NuspecFile>
 
     <RootNamespace>Reqnroll.Autofac</RootNamespace>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll Autofac integration plugin</title>
     <authors>Gaspar Nagy, Spec Solutions, $author$</authors>
     <owners>Gaspar Nagy, Spec Solutions, $owner$</owners>
+    <readme>README.md</readme>
     <description>Reqnroll plugin that enables to use Autofac for resolving test dependencies.</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -29,6 +30,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.Autofac.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.CustomPlugin/README.md

@@ -0,0 +1,9 @@
+Reqnroll.CustomPlugin provides a sample custom plugin for Reqnroll.
+
+This package serves as a template and example for creating custom plugins that extend Reqnroll functionality. It demonstrates how to create custom generators, transformations, and other extensions.
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj

@@ -7,7 +7,8 @@
 
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
     <NoPackageAnalysis>true</NoPackageAnalysis>
-
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll.CustomPlugin</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package for writing custom generator extensions for Reqnroll.</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -29,6 +30,7 @@
     <file src="$SolutionDir$\Licenses\*" target="Licenses" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 

Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md

@@ -0,0 +1,15 @@
+Reqnroll.ExternalData provides external data loading capabilities for Reqnroll scenarios.
+
+The Reqnroll ExternalData plugin lets teams separate test data from test scenarios, and reuse examples across a large set of scenarios. This is particularly helpful when a common set of examples needs to be consistently verified in different scenarios.
+
+Supported Data Sources: CSV, JSON, and excel files
+
+## Documentation
+
+For more information about using external data with Reqnroll, see [External Data Plugin - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/externaldata.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec

@@ -5,6 +5,7 @@
     <title>Reqnroll.ExternalData</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use external data in Gherkin scenarios</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -24,6 +25,7 @@
     <file src="bin\$config$\netstandard2.0\*" target="build\netstandard2.0"/>
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md

@@ -0,0 +1,13 @@
+Reqnroll.MSTest enables using Reqnroll with [MSTest v2 test framework](https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-csharp-with-mstest).
+
+This package provides integration between Reqnroll and MSTest v2, allowing you to write BDD tests using Gherkin syntax that run with the MSTest test framework.
+
+## Documentation
+
+For more information about using Reqnroll with MSTest, visit the [MSTest - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/mstest.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.Generator.ReqnrollPlugin.csproj

@@ -7,6 +7,8 @@
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
     <PackageId>Reqnroll.MsTest</PackageId>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
   <ItemGroup>
     <Compile Remove="build\**\*" />

Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll.MsTest</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use Reqnroll for use with MsTest v2. $summary$</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -32,6 +33,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.MSTest.Generator.ReqnrollPlugin.pdb" target="build\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md

@@ -0,0 +1,13 @@
+Reqnroll.Microsoft.Extensions.DependencyInjection provides [Microsoft.Extensions.DependencyInjection](https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection-usage) integration for Reqnroll.
+
+This package enables Reqnroll to use the standard .NET dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests.
+
+## Documentation
+
+For more information about using dependency injection with Reqnroll, see [Microsoft.Extensions.DependencyInjection - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/dependency-injection.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll Microsoft.Extensions.DependencyInjection integration plugin</title>
     <authors>Mark Hoek, Solid Token, Stef Heyenrath, $author$</authors>
     <owners>Mark Hoek, Solid Token, Stef Heyenrath, $owner$</owners>
+    <readme>README.md</readme>
     <description>Reqnroll plugin that enables to use Microsoft.Extensions.DependencyInjection for resolving test dependencies.</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -29,6 +30,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md

@@ -0,0 +1,13 @@
+Reqnroll.NUnit enables using Reqnroll with [NUnit test framework](https://nunit.org/).
+
+This package provides integration between Reqnroll and NUnit, allowing you to write BDD tests using Gherkin syntax that run with the NUnit test framework.
+
+## Documentation
+
+For more information about using Reqnroll with NUnit, see [NUnit - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/nunit.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.Generator.ReqnrollPlugin.csproj

@@ -7,6 +7,8 @@
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
     <PackageId>Reqnroll.NUnit</PackageId>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
   <ItemGroup>
     <Compile Remove="build\**\*" />

Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll.NUnit</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use Reqnroll with NUnit 3.13 and later. $summary$</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -32,6 +33,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.NUnit.Generator.ReqnrollPlugin.pdb" target="build\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md

@@ -0,0 +1,9 @@
+Reqnroll.SpecFlowCompatibility provides compatibility layer for migrating from SpecFlow to Reqnroll.
+
+This package helps ease the [migration from SpecFlow](https://docs.reqnroll.net/latest/guides/migrating-from-specflow.html) by providing compatibility shims and adapters, allowing you to gradually migrate your existing SpecFlow tests to Reqnroll.
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll.SpecFlowCompatibility</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Enables SpecFlow compatibility mode for Reqnroll</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -35,6 +36,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.SpecFlowCompatibility.*" target="build\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md

@@ -0,0 +1,9 @@
+Reqnroll.TUnit enables using Reqnroll with TUnit test framework.
+
+This package provides integration between Reqnroll and [TUnit](https://tunit.dev/), allowing you to write BDD tests using Gherkin syntax that run with the TUnit test framework.
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj

@@ -9,7 +9,8 @@
     <PackageId>Reqnroll.TUnit</PackageId>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <!-- build incorrectly detects a missing content in the 'lib' folder, we need to skip this warning -->
-    <NoWarn>$(NoWarn);NU5128</NoWarn>
+    <NoWarn>$(NoWarn);NU5128;1591</NoWarn>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <PropertyGroup>

Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.nuspec

@@ -31,6 +31,7 @@
     <file src="..\Reqnroll.TUnit.ReqnrollPlugin\bin\$config$\netstandard2.0\Reqnroll.TUnit.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
     <file src="bin\$config$\netstandard2.0\Reqnroll.TUnit.Generator.ReqnrollPlugin.dll" target="build\netstandard2.0" />
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md

@@ -0,0 +1,13 @@
+Reqnroll.Verify provides integration with [Verify](https://github.com/VerifyTests/Verify) for snapshot testing in Reqnroll scenarios.
+
+This package enables Reqnroll to use Verify for approval/snapshot testing, allowing you to verify complex objects, text outputs, and other test results using the Verify library.
+
+## Documentation
+
+For more information about using Verify with Reqnroll, see [Verify - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/verify.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.nuspec

@@ -5,6 +5,7 @@
     <title>Reqnroll.Verify</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use Verify.Xunit with Reqnroll</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -34,6 +35,7 @@
     <file src="bin\$config$\net8.0\Reqnroll.Verify.ReqnrollPlugin.*" target="lib\net8.0"/>
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.Windsor.ReqnrollPlugin/README.md

@@ -0,0 +1,13 @@
+Reqnroll.Windsor provides [Castle Windsor](https://github.com/castleproject/Windsor) dependency injection integration for Reqnroll.
+
+This package enables Reqnroll to use Castle Windsor as the dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests.
+
+## Documentation
+
+For more information about using dependency injection with Reqnroll, see [Castle Windsor - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/windsor.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.ReqnrollPlugin.csproj

@@ -8,6 +8,8 @@
     <PackageId>Reqnroll.Windsor</PackageId>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <NuspecFile>$(MSBuildThisFileDirectory)Reqnroll.Windsor.nuspec</NuspecFile>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll Windsor integration plugin</title>
     <authors>$author$</authors>
     <owners>Gaspar Nagy, Spec Solutions, $owner$</owners>
+    <readme>README.md</readme>
     <description>Reqnroll plugin that enables to use Windsor for resolving test dependencies.</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -29,6 +30,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.Windsor.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/README.md

@@ -0,0 +1,13 @@
+Reqnroll.xUnit enables using Reqnroll with [xUnit test framework v2](https://xunit.net/docs/getting-started/v2/getting-started).
+
+This package provides integration between Reqnroll and xUnit, allowing you to write BDD tests using Gherkin syntax that run with the xUnit test framework.
+
+## Documentation
+
+For more information about using Reqnroll with xUnit, see [xUnit - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/xunit.html).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.Generator.ReqnrollPlugin.csproj

@@ -7,6 +7,8 @@
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageId>Reqnroll.xUnit</PackageId>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
   <ItemGroup>
     <Compile Remove="build\**\*" />

Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec

@@ -6,8 +6,8 @@
     <title>Reqnroll.xUnit</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use Reqnroll with xUnit 2.x. Use Reqnroll.xunit.v3 for xUnit 3.x. $summary$</description>
-    <summary>Package to use Reqnroll with xUnit 2.x. Use Reqnroll.xunit.v3 for xUnit 3.x. $summary$</summary>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
     <repository type="git" url="https://github.com/reqnroll/Reqnroll.git" branch="$branch$" commit="$commit$" />
@@ -41,6 +41,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.xUnit.Generator.ReqnrollPlugin.pdb" target="build\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>