Merge pull request #47 from atc-net/hotfix/improve-the-version-experience-for-version-290

Hotfix/improve the version experience for version 290

Author: davidkallesen

Atc.Test.sln

@@ -26,6 +26,11 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{4B46C47D-D
 		test\Directory.Build.props = test\Directory.Build.props
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{014851A9-0672-4268-9856-181B0BB26F71}"
+	ProjectSection(SolutionItems) = preProject
+		README.md = README.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

README.md

@@ -4,6 +4,12 @@
 
 Common tools for writing tests using XUnit, AutoFixture, NSubstitute and FluentAssertions.
 
+> **Version Notes:**  
+> If you are using the `MemberAutoNSubstituteData` attribute, ensure that both `xunit` and `xunit.extensibility.core` packages are set to version **2.9.0**.
+> This is because the latest versions of xUnit are currently incompatible with `MemberAutoNSubstituteData` due to an unresolved issue. Although [xunit/xunit#3031](https://github.com/xunit/xunit/issues/3031) has been closed, the problem remains unresolved.  
+> Upgrading beyond version 2.9.0 may result in test failures or unexpected behavior.
+
+
 ## Test Attributes
 
 | Name | Description |
@@ -12,7 +18,8 @@ Common tools for writing tests using XUnit, AutoFixture, NSubstitute and FluentA
 | `InlineAutoNSubstituteData` | Provides a data source for a data theory, with the data coming from inline values combined with auto-generated data specimens generated by AutoFixture and NSubstitute.|
 | `MemberAutoNSubstituteData` | Provides a data source for a data theory, with the data coming from one of the following sources and combined with auto-generated data specimens generated by AutoFixture and NSubstitute.|
 
-Note: NSubstitute is used when the type being created is abstract, or when the `[Substitute]` is applied.
+> **Note:**
+> NSubstitute is used when the type being created is abstract, or when the `[Substitute]` is applied.
 
 ## Test Helpers
 

src/Atc.Test/Atc.Test.csproj

@@ -20,7 +20,8 @@
     <PackageReference Include="NSubstitute" Version="5.3.0" />
     <PackageReference Include="System.Net.Http" Version="4.3.4" />
     <PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
-    <PackageReference Include="xunit.extensibility.core" Version="[2.9.0]" /> <!-- xunit.extensibility.core is version-pinned because versions newer than 2.9.0 introduce bugs -->
+    <PackageReference Include="xunit" Version="2.9.0" /> <!-- xunit should not be upgraded since newer version than 2.9.0 introduce bugs for MemberAutoNSubstituteDataAttribute -->
+    <PackageReference Include="xunit.extensibility.core" Version="2.9.0" /> <!-- xunit.extensibility.core should not be upgraded since newer version than 2.9.0 introduce bugs for MemberAutoNSubstituteDataAttribute -->
     <PackageReference Include="System.Text.Json" Version="8.0.5" />
   </ItemGroup>
 

test/Atc.Test.Tests/Atc.Test.Tests.csproj

@@ -13,7 +13,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="6.0.3">
+    <PackageReference Include="coverlet.collector" Version="6.0.4">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>