ardalis/SmartEnum

Support ReadAsPropertyName and WriteAsPropertyName in System.Text.Json support

Open

#242 opened on Mar 9, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C# (185 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (2,420 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

ReadAsPropertyName and WriteAsPropertyName are virtual methods on JsonConverter used to support custom key types for dictionary serialization, and currently throw an exception in the case of smartenums

Contributor guide

Research direction
Inspect the current JsonConverter implementation for SmartEnum to understand how Read and Write are implemented. Identify where the exception is thrown for ReadAsPropertyName and WriteAsPropertyName. Then override these virtual methods to support custom key types for dictionary serialization.
Tech stack
csharp
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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.
Mostly clear
Prerequisites
C#System.Text.Json
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60