🤖 Generated by the Daily AI Assistant
Part of the roadmap epic #167 (direction 3 — exemplary by example).
Problem
The scaffold's example models no pattern a new project would want to copy:
src/Example/ExampleClass.cs is an empty class (no members).tests/Example.Tests/ExampleClassTests.cs has a single Test1() that only does Assert.NotNull(new ExampleClass()).
The test name (Test1) and the trivial assertion teach an adopter nothing about the house testing convention. Since the whole point of a template is to set the pattern, the example should be exemplary — while staying minimal.
Proposed direction
- Give
ExampleClass one minimal, idiomatic, documented member (e.g. a trivial pure method or property) — enough to have real behaviour to assert. Keep it tiny; no product features.
- Rewrite the test to model the house convention: a descriptive name (
Method_State_ExpectedResult), explicit Arrange / Act / Assert, and an assertion on actual behaviour (not just non-null).
- Keep XML doc comments on both (the projects already set
GenerateDocumentationFile).
Acceptance criteria
ExampleClass has one documented member; the example remains minimal and idiomatic.- The test follows the
Method_State_Expected naming convention with clear AAA and asserts real behaviour.
dotnet build + dotnet test pass with TreatWarningsAsErrors enabled.
Size
XS — lowest priority of the three; pure scaffolding polish. Good first issue.
Part of the roadmap epic #167 (direction 3 — exemplary by example).
Problem
The scaffold's example models no pattern a new project would want to copy:
src/Example/ExampleClass.csis an empty class (no members).tests/Example.Tests/ExampleClassTests.cshas a singleTest1()that only doesAssert.NotNull(new ExampleClass()).The test name (
Test1) and the trivial assertion teach an adopter nothing about the house testing convention. Since the whole point of a template is to set the pattern, the example should be exemplary — while staying minimal.Proposed direction
ExampleClassone minimal, idiomatic, documented member (e.g. a trivial pure method or property) — enough to have real behaviour to assert. Keep it tiny; no product features.Method_State_ExpectedResult), explicit Arrange / Act / Assert, and an assertion on actual behaviour (not just non-null).GenerateDocumentationFile).Acceptance criteria
ExampleClasshas one documented member; the example remains minimal and idiomatic.Method_State_Expectednaming convention with clear AAA and asserts real behaviour.dotnet build+dotnet testpass withTreatWarningsAsErrorsenabled.Size
XS — lowest priority of the three; pure scaffolding polish. Good first issue.