Pragmatists/JUnitParams

Add explanations to examples in documentation

Open

#141 opened on Oct 27, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (151 forks)batch import
help wanted

Repository metrics

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

Description

Without explanations of the many different ways to specify parameters, figuring out how to use this library is harder than it should be.

Also, most of the examples seem to demonstrate passing just a single parameter (or a set of parameters for a single invocation). It's not obvious how to pass several parameters.

Contributor guide

Research direction
Review the existing example files and identify where explanations are missing; then add descriptive comments or markdown sections explaining parameter variations and multiple parameter passing.
Tech stack
java
Domain
testing
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80