allure-framework / allure-framework/allure-csharp

Xml doc to description conversion

Open
#405 0 comments 0 reactions 0 assignees View on GitHub
task:new feature theme:core
Dominant language
C#
Stars
125
Forks
76
Avg merge
1d 2h
Merged PRs (30d)
18

Description

The following usage:

```csharp
class MyTestClass
{
///
/// The description of the test method.
///
[Test]
public void MyTest()
{
/* ... */
}
}
```

should be equivalent to

```csharp
class MyTestClass
{
[Test]
[AllureDescription("The description of the test method.")]
public void MyTest()
{
/* ... */
}
}
```

#### Considerations

- [ ] Explore the possibility of getting a test method's xml documentation
- [ ] Implement doc-to-string conversion

Contributor guide

Open the contributing guide

Research direction

Start by investigating how the C# test integration exposes test methods and whether their XML documentation is available at runtime. Explore the two checklist items, then verify the conversion with a focused test based on the shown MyTest example; done means its report description matches the text.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.