haskell/aeson

Add "since" information to documentation

Open

#882 opened on Oct 11, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (1,298 stars) (334 forks)batch import
good first issuehelp wanted

Description

E.g. module Data.Aeson.Key is new. A Since: 2.0.0.0 would be helpful. Likewise for other new functionality.

Contributor guide

Tech stack
None
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of aeson's changelogbasic Haskell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the Haddock comments in the modules, especially new ones like Data.Aeson.Key. Look at the changelog to determine the version when each module was introduced. Add @since annotations following the convention used elsewhere in the project.