Add READMEs and XML documentation to all NuGet packages #844

304NotModified · 2025-09-17T21:49:14Z

🤔 What's changed?

Added readmes to all NuGet packages, with the help of Copilot. I reviewed all the readmes and edited most of them.
Added XML docs to the NuGet packages
Added NoWarn for "Missing XML comment for publicly visible type or member" (CS1591), otherwise there are many warnings.
Removed old <summary> from xunit3 package (was already removed for others) - see Removed deprecated <summary> from NuGet packages #766

See also validation results, the warning for the reqnroll pacakge is fine (will disable in the future)

The Verify package has still some issues, that is out of scope here, see #709

⚡️ What's your motivation?

Better documentation

🏷️ What kind of change is this?

📖 Documentation (improvements without changing code)

📋 Checklist:

I have added an entry to the "[vNext]" section of the CHANGELOG, linking to this pull request & included my GitHub handle to the release contributors list.

…nroll.Generator, Reqnroll.Utils, Reqnroll.Tools.MsBuild.Generation Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>

…nit, xUnit, TUnit Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>

…, DI, ExternalData, Verify, SpecFlowCompatibility, CustomPlugin, Templates Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>

…pdate links, change bash to powershell Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>

…50bd

Copilot

Pull Request Overview

This pull request adds comprehensive documentation by including README files and enabling XML documentation generation for all NuGet packages in the Reqnroll project.

Adds README.md files to 20+ NuGet packages with concise descriptions and usage information
Enables XML documentation generation (GenerateDocumentationFile) for better API documentation
Updates package configuration to include README files in NuGet packages

Reviewed Changes

Copilot reviewed 41 out of 42 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
Templates/Reqnroll.Templates.DotNet/*	Adds README and package configuration for dotnet templates
Reqnroll/Reqnroll.nuspec	Updates README file reference from PackageReadme.md to README.md
Reqnroll.Utils/*	Adds README and XML documentation configuration
Reqnroll.Tools.MsBuild.Generation/*	Adds README and XML documentation for MSBuild generation tools
Reqnroll.Parser/*	Adds README and XML documentation for Gherkin parser
Reqnroll.Generator/*	Adds README and XML documentation for code generator
Plugins/*/README.md	Adds READMEs for all plugin packages (xUnit, Windsor, Verify, TUnit, SpecFlow compatibility, NUnit, Microsoft DI, MSTest, ExternalData, CustomPlugin, Autofac)
Plugins//.csproj	Enables XML documentation generation for plugin projects
Plugins//.nuspec	Updates package specifications to include README files

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

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

304NotModified · 2025-09-17T23:08:22Z

@gasparnagy It would be nice if we could include this for 3.1 :)

304NotModified · 2025-09-17T23:37:30Z

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

    <file src="build\**\*" exclude="build\*.template.*" target="build" />
-    <file src="bin\$config$\netstandard2.0\Reqnroll.xUnit.ReqnrollPlugin.*" target="lib\netstandard2.0" />
-    <file src="bin\$config$\net462\Reqnroll.xUnit.ReqnrollPlugin.*" target="lib\net462" />
+    <file src="bin\$config$\netstandard2.0\Reqnroll.xUnit.ReqnrollPlugin.dll" target="lib\netstandard2.0" />


TODO double check with current package on nuget

gasparnagy · 2025-09-18T04:50:14Z

@gasparnagy It would be nice if we could include this for 3.1 :)

Would be great. But let's wait for #812 to be finished first.

gasparnagy · 2025-09-24T12:51:53Z

@304NotModified #812 is merged. Do you see a chance you can update this until the end of this week?

gasparnagy

Thx. I have checked the first few readme, but they require more work. I will continue later.

gasparnagy · 2025-09-26T12:49:24Z

Plugins/Reqnroll.CustomPlugin/README.md

@@ -0,0 +1,9 @@
+Reqnroll.CustomPlugin provides a sample custom plugin for Reqnroll.


It should be "Reqnroll.CustomPlugin provides the required dependencied for writing custom Reqnroll generator extensions."

gasparnagy · 2025-09-26T12:50:04Z

Plugins/Reqnroll.CustomPlugin/README.md

+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)


link to https://docs.reqnroll.net/latest/extend/plugins.html#generator-plugins instead

gasparnagy · 2025-09-26T12:50:37Z

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

+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)


https://docs.reqnroll.net/latest/integrations/externaldata.html

gasparnagy · 2025-09-26T12:54:59Z

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.


"standard .NET dependency injection container": I wouldn't call it "standard" (despite what MS thinks). I would say "This package enables Reqnroll to dependency injection container from the Microsoft.Extensions.DependencyInjection package for ..."

gasparnagy · 2025-09-26T12:55:14Z

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

+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)


https://docs.reqnroll.net/latest/integrations/dependency-injection.html

Copilot AI and others added 7 commits August 16, 2025 22:07

Initial plan

a6693c1

Add README files and XML docs for core packages: Reqnroll.Parser, Req…

7a70f10

…nroll.Generator, Reqnroll.Utils, Reqnroll.Tools.MsBuild.Generation Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>

Add README files and XML docs for test framework packages: MSTest, NU…

0a41b26

…nit, xUnit, TUnit Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>

Add README files and XML docs for remaining plugins: Autofac, Windsor…

d01d9a3

…, DI, ExternalData, Verify, SpecFlowCompatibility, CustomPlugin, Templates Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>

Address README feedback: rename files, remove pronunciation guides, u…

3eb6338

…pdate links, change bash to powershell Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>

Merge branch 'main' into copilot/fix-838c609e-2773-4068-b012-87d60b43…

1392e15

…50bd

Update readmes

821f5d9

304NotModified mentioned this pull request Sep 17, 2025

Add README files and enable XML documentation for all NuGet packages #770

Closed

304NotModified added the documentation Improvements or additions to documentation label Sep 17, 2025

304NotModified changed the title ~~Add README files and enable XML documentation for all NuGet packages~~ Add READMEs and enable XML documentation to all NuGet packages Sep 17, 2025

304NotModified requested a review from Copilot September 17, 2025 21:50

304NotModified changed the title ~~Add READMEs and enable XML documentation to all NuGet packages~~ Add READMEs and XML documentation to all NuGet packages Sep 17, 2025

Copilot AI reviewed Sep 17, 2025

View reviewed changes

Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/Reqnroll.xUnit.nuspec Show resolved Hide resolved

304NotModified added 2 commits September 17, 2025 23:52

Update CHANGELOG.md

26ee352

include xml in nuspec

b4f0512

304NotModified force-pushed the package-readmes branch from bec5177 to b4f0512 Compare September 17, 2025 22:06

304NotModified added 10 commits September 18, 2025 00:07

include readme

12cb681

Readme xunit3

581e140

remove old summary

57093b1

fix readme

4ca5580

GenerateDocumentationFile

1c6947d

fix file paths

7447976

fix xml include in tunit

2c8d598

fix xml docs

1fd6c2c

dont include deps.json

fc2087a

fix docs

d0062d8

304NotModified force-pushed the package-readmes branch 2 times, most recently from 1ee3381 to 1783253 Compare September 17, 2025 23:12

no wildcards in nuspec

9735ae7

304NotModified force-pushed the package-readmes branch from 1783253 to 9735ae7 Compare September 17, 2025 23:15

fix xunit.v3 package

0c90b50

304NotModified commented Sep 17, 2025

View reviewed changes

304NotModified marked this pull request as ready for review September 17, 2025 23:37

304NotModified mentioned this pull request Sep 17, 2025

Simplified MSBuild Package #812

Merged

gasparnagy requested changes Sep 26, 2025

View reviewed changes

304NotModified marked this pull request as draft October 8, 2025 22:48

304NotModified added the parked We decided to delay dealing with this label Dec 15, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add READMEs and XML documentation to all NuGet packages #844

Add READMEs and XML documentation to all NuGet packages #844

Uh oh!

304NotModified commented Sep 17, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

304NotModified commented Sep 17, 2025

Uh oh!

304NotModified Sep 17, 2025

Uh oh!

gasparnagy commented Sep 18, 2025

Uh oh!

gasparnagy commented Sep 24, 2025

Uh oh!

gasparnagy left a comment

Uh oh!

gasparnagy Sep 26, 2025

Uh oh!

gasparnagy Sep 26, 2025

Uh oh!

gasparnagy Sep 26, 2025

Uh oh!

gasparnagy Sep 26, 2025

Uh oh!

gasparnagy Sep 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -0,0 +1,9 @@
		Reqnroll.CustomPlugin provides a sample custom plugin for Reqnroll.


		## Support

		- [Reqnroll Documentation](https://docs.reqnroll.net/)

		@@ -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.

Add READMEs and XML documentation to all NuGet packages #844

Are you sure you want to change the base?

Add READMEs and XML documentation to all NuGet packages #844

Uh oh!

Conversation

304NotModified commented Sep 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🤔 What's changed?

⚡️ What's your motivation?

🏷️ What kind of change is this?

📋 Checklist:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

304NotModified commented Sep 17, 2025

Uh oh!

304NotModified Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

gasparnagy commented Sep 18, 2025

Uh oh!

gasparnagy commented Sep 24, 2025

Uh oh!

gasparnagy left a comment

Choose a reason for hiding this comment

Uh oh!

gasparnagy Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

gasparnagy Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

gasparnagy Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

gasparnagy Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

gasparnagy Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

304NotModified commented Sep 17, 2025 •

edited

Loading