Skip to content

Commit

Permalink
docs: Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
samtrion committed Feb 13, 2024
1 parent 0e3196f commit 37b6104
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 52 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
Justification = "As designed."
)]
[AttributeUsage(
AttributeTargets.Class | AttributeTargets.Method,
AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Method,
AllowMultiple = true,
Inherited = true
)]
Expand Down
36 changes: 19 additions & 17 deletions src/NetEvolve.Extensions.MSTest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,30 @@ The following test frameworks are supported -

For consistent usage and addressing of use cases like `dotnet test -c Release --filter TestCategory=IntegrationTest`, the following attributes are provided in this library in the namespace `NetEvolve.Extensions.MSTest`.

- `AcceptanceTestAttribute`
- `BugAttribute`
- `EndToEndTestAttribute`
- `EpicAttribute`
- `FeatureAttribute`
- `FunctionalTestAttribute`
- `IntegrationTestAttribute`
- `IssueAttribute`
- `PerformanceTestAttribute`
- `PostDeploymentTestAttribute`
- `PreDeploymentTestAttribute`
- `UnitTestAttribute`
- `UserStoryAttribute`
- `WorkItemAttribute`
- `AcceptanceTestAttribute`
- `ArchitectureTestAttribute`
- `BugAttribute`
- `EndToEndTestAttribute`
- `EpicAttribute`
- `FeatureAttribute`
- `FunctionalTestAttribute`
- `IntegrationTestAttribute`
- `IssueAttribute`
- `PerformanceTestAttribute`
- `PostDeploymentTestAttribute`
- `PreDeploymentTestAttribute`
- `UnitTestAttribute`
- `UserStoryAttribute`
- `WorkItemAttribute`

### Applying

These can be applied to all class and method definitions as follows.
These can be applied on assembly, class or method definitions as follows.

```cs
[assembly: AcceptanceTest] // Mark all test methods of this assembly as AcceptanceTest
[TestClass]
[AcceptanceTest] // Mark all test methods as AcceptanceTest
[AcceptanceTest] // Mark all test methods of this class as AcceptanceTest
public partial class FantasticTest
{
[TestMethod]
Expand Down
36 changes: 19 additions & 17 deletions src/NetEvolve.Extensions.NUnit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,30 @@ For consistent usage and addressing of use cases like
`dotnet test -c Release --filter TestCategory=IntegrationTest`,
the following attributes are provided in this library in the namespace `NetEvolve.Extensions.NUnit`.

- `AcceptanceTestAttribute`
- `BugAttribute`
- `EndToEndTestAttribute`
- `EpicAttribute`
- `FeatureAttribute`
- `FunctionalTestAttribute`
- `IntegrationTestAttribute`
- `IssueAttribute`
- `PerformanceTestAttribute`
- `PostDeploymentTestAttribute`
- `PreDeploymentTestAttribute`
- `UnitTestAttribute`
- `UserStoryAttribute`
- `WorkItemAttribute`
- `AcceptanceTestAttribute`
- `ArchitectureTestAttribute`
- `BugAttribute`
- `EndToEndTestAttribute`
- `EpicAttribute`
- `FeatureAttribute`
- `FunctionalTestAttribute`
- `IntegrationTestAttribute`
- `IssueAttribute`
- `PerformanceTestAttribute`
- `PostDeploymentTestAttribute`
- `PreDeploymentTestAttribute`
- `UnitTestAttribute`
- `UserStoryAttribute`
- `WorkItemAttribute`

### Applying

These can be applied to all class and method definitions as follows.
These can be applied on assembly, class or method definitions as follows.

```cs
[assembly: AcceptanceTest] // Mark all test methods of this assembly as AcceptanceTest
[TestFixture]
[AcceptanceTest] // Mark all test methods as AcceptanceTest
[AcceptanceTest] // Mark all test methods of this class as AcceptanceTest
public partial class FantasticTest
{
[Test]
Expand Down
36 changes: 19 additions & 17 deletions src/NetEvolve.Extensions.XUnit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,29 @@ For consistent usage and addressing of use cases like
`dotnet test -c Release --filter TestCategory=IntegrationTest`,
the following attributes are provided in this library in the namespace `NetEvolve.Extensions.XUnit`.

- `AcceptanceTestAttribute`
- `BugAttribute`
- `EndToEndTestAttribute`
- `EpicAttribute`
- `FeatureAttribute`
- `FunctionalTestAttribute`
- `IntegrationTestAttribute`
- `IssueAttribute`
- `PerformanceTestAttribute`
- `PostDeploymentTestAttribute`
- `PreDeploymentTestAttribute`
- `UnitTestAttribute`
- `UserStoryAttribute`
- `WorkItemAttribute`
- `AcceptanceTestAttribute`
- `ArchitectureTestAttribute`
- `BugAttribute`
- `EndToEndTestAttribute`
- `EpicAttribute`
- `FeatureAttribute`
- `FunctionalTestAttribute`
- `IntegrationTestAttribute`
- `IssueAttribute`
- `PerformanceTestAttribute`
- `PostDeploymentTestAttribute`
- `PreDeploymentTestAttribute`
- `UnitTestAttribute`
- `UserStoryAttribute`
- `WorkItemAttribute`

### Applying

These can be applied to all class and method definitions as follows.
These can be applied on assembly, class or method definitions as follows.

```cs
[AcceptanceTest] // Mark all test methods as AcceptanceTest
[assembly: AcceptanceTest] // Mark all test methods of this assembly as AcceptanceTest
[AcceptanceTest] // Mark all test methods of this class as AcceptanceTest
public partial class FantasticTest
{
[Fact]
Expand Down

0 comments on commit 37b6104

Please sign in to comment.