zio/izumi-reflect

Docs required

Open

#340 opened on Nov 16, 2022

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Scala (66 forks)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (156 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We need to better document the internals of the library, the design decisions we made and trade-offs and limitations we had to deal with.

This should allow potential contributors to quicker get onto the board.

Contributor guide

Research direction
Explore the source code structure and identify key modules and design decisions. Look at existing documentation and code comments to understand the architecture.
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.
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.
Clear
Prerequisites
ScalaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60