dotnet/runtime

JSON attributes docs should have mentions for corresponding metadata

Open

#84,069 opened on Mar 29, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (5,445 forks)batch import
area-System.Text.Jsondocumentationhelp wanted

Repository metrics

Stars
 (17,886 stars)
PR merge metrics
 (Avg merge 12d 11h) (661 merged PRs in 30d)

Description

Currently some of our attributes contain metadata reference and some don't.

Review all of them and make sure they do (when possible): https://github.com/dotnet/runtime/tree/main/src/libraries/System.Text.Json/src/System/Text/Json/Serialization/Attributes

Originally posted by @layomia in https://github.com/dotnet/runtime/pull/83669#discussion_r1150851799

Contributor guide

Research direction
Review each attribute file in the specified directory and ensure it includes a reference to its corresponding metadata documentation if applicable.
Tech stack
csharp
Domain
documentation
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBasic .NET knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70