dotnet/roslyn

Improve docs for testing source generators

Open

#58,945 opened on Jan 19, 2022

View on GitHub
 (18 comments) (8 reactions) (1 assignee)C# (4,257 forks)batch import
Area-CompilersDocumentationhelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

The current docs for tests for source generators is missing some important information about testing. For example, how to add references to the compilation. The current example is a good quick start but is not enough.

Docs link: https://github.com/dotnet/roslyn/blob/main/docs/features/source-generators.cookbook.md#unit-testing-of-generators

Contributor guide

Research direction
Examine the current documentation for testing source generators and identify the missing information about adding references to the compilation. Then update the cookbook page with more comprehensive examples.
Tech stack
csharp
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80