-
Notifications
You must be signed in to change notification settings - Fork 114
Add READMEs and XML documentation to all NuGet packages #844
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
304NotModified
wants to merge
28
commits into
main
Choose a base branch
from
package-readmes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
28 commits
Select commit
Hold shift + click to select a range
a6693c1
Initial plan
Copilot 7a70f10
Add README files and XML docs for core packages: Reqnroll.Parser, Req…
Copilot 0a41b26
Add README files and XML docs for test framework packages: MSTest, NU…
Copilot d01d9a3
Add README files and XML docs for remaining plugins: Autofac, Windsor…
Copilot 3eb6338
Address README feedback: rename files, remove pronunciation guides, u…
Copilot 1392e15
Merge branch 'main' into copilot/fix-838c609e-2773-4068-b012-87d60b43…
304NotModified 821f5d9
Update readmes
304NotModified 26ee352
Update CHANGELOG.md
304NotModified b4f0512
include xml in nuspec
304NotModified 12cb681
include readme
304NotModified 581e140
Readme xunit3
304NotModified 57093b1
remove old summary
304NotModified 4ca5580
fix readme
304NotModified 1c6947d
GenerateDocumentationFile
304NotModified 7447976
fix file paths
304NotModified 2c8d598
fix xml include in tunit
304NotModified 1fd6c2c
fix xml docs
304NotModified fc2087a
dont include deps.json
304NotModified d0062d8
fix docs
304NotModified 9735ae7
no wildcards in nuspec
304NotModified 0c90b50
fix xunit.v3 package
304NotModified afed01c
Address PR feedback on NuGet package README files (#1037)
Copilot 8de380f
Initial plan
Copilot 0b9ca35
Merge branch 'main' of https://github.com/reqnroll/Reqnroll into copi…
Copilot a152fd7
Add missing PackageReadme.md for Reqnroll package
Copilot 68fabf1
Fix incorrect PackageTags for Microsoft.Extensions.DependencyInjectio…
Copilot 2e04207
Fix comment in NUnit plugin - reference NUnit not MSTest
Copilot 7898c90
Merge pull request #1038 from reqnroll/copilot/sub-pr-844-again
304NotModified File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| Reqnroll.CustomPlugin provides the required dependencies for writing custom Reqnroll generator extensions. | ||
|
|
||
| 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. | ||
|
|
||
| ## Documentation | ||
|
|
||
| For more information about creating custom generator plugins, see [Generator Plugins - Reqnroll documentation](https://docs.reqnroll.net/latest/extend/plugins.html#generator-plugins). | ||
|
|
||
| ## Support | ||
|
|
||
| - [Reqnroll Documentation](https://docs.reqnroll.net/) | ||
| - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) | ||
| - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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/) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) | ||
| - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 dependency injection container from the Microsoft.Extensions.DependencyInjection package 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/) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) | ||
| - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 9 additions & 0 deletions
9
Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| Reqnroll.xUnit enables using Reqnroll with [xUnit test framework v2](https://xunit.net/docs/getting-started/v2/getting-started). | ||
|
|
||
| For xUnit 2, use the package Reqnroll.xunit.v3 | ||
|
|
||
| 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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
Plugins/Reqnroll.xUnit3.Generator.ReqnrollPlugin/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| Reqnroll.xUnit enables using Reqnroll with [xUnit test framework v3](https://xunit.net/docs/getting-started/v3/getting-started). | ||
|
|
||
| For xUnit 2, use the package Reqnroll.xUnit | ||
|
|
||
| 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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| Reqnroll.Generator is the code generation component of the Reqnroll framework. | ||
|
|
||
| This package provides code generation capabilities that convert Gherkin feature files into executable test code for the Reqnroll BDD test automation framework for .NET. For generator configuration options, see the [Generator Configuration Documentation](https://docs.reqnroll.net/latest/installation/configuration.html#generator). | ||
|
|
||
| ## Key Features | ||
|
|
||
| - **Code Generation**: Converts Gherkin feature files into C# test code | ||
| - **Test Framework Integration**: Supports multiple test frameworks (MSTest, NUnit, xUnit) | ||
| - **Binding Generation**: Generates binding code and step definition skeletons | ||
| - **Multiple Target Frameworks**: Supports .NET Standard 2.0 and later | ||
|
|
||
| ## Documentation | ||
|
|
||
| For more information about Reqnroll and its components, visit the [documentation](https://docs.reqnroll.net/). | ||
|
|
||
| ## Support | ||
|
|
||
| - [Reqnroll Documentation](https://docs.reqnroll.net/) | ||
| - [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) | ||
| - [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
link to https://docs.reqnroll.net/latest/extend/plugins.html#generator-plugins instead