RicoSuter/NJsonSchema

Translate schema comments ($comment) to C# documentation comments

Open

#1,428 opened on Nov 3, 2021

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)C# (549 forks)github user discovery
help wantedproject: NJsonSchema.CodeGeneration.CSharptype: question

Repository metrics

Stars
 (1,579 stars)
PR merge metrics
 (Avg merge 39d 6h) (1 merged PR in 30d)

Description

Could you take the content of the $comment field and translate it into a C# doc comment?

Contributor guide

Research direction
Inspect how $comment is parsed in NJsonSchema and add logic to emit C# XML doc comments in generated code.
Tech stack
csharp
Domain
backenddocumentation
Issue type
Feature
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#JSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75