dry-rb/dry-validation

"External dependencies" doc page should mention and link to dry-initializer

Open

#637 opened on Apr 9, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Ruby (196 forks)github user discovery
docsitehelp wanted

Repository metrics

Stars
 (1,422 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

There's no information on this page about how exactly the option DSL works. We could clarify things with a sentence saying it is provided by dry-initializer and linking to its docs.

That would help people e.g. wanting to work out how to provide default values for options, etc., without us needing to repeat that information here.

Contributor guide

Research direction
Locate the 'External dependencies' documentation page in the dry validation repository and add a sentence explaining that the `option` DSL is provided by dry initializer, with a link to its documentation.
Tech stack
ruby
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90