spockframework/spock

Documentation for spock.util.concurrent classes

Open

#1,058 opened on Nov 27, 2019

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Java (3,457 stars) (466 forks)batch import
help wanted

Description

The classes in package spock.util.concurrent are only briefly mentioned in the Changelog. Please add documentation for them to the normal Userguide.

Contributor guide

Tech stack
javagroovy
Domain
testingdocumentation
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
Basic knowledge of Spock frameworkFamiliarity with spock.util.concurrent package
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Locate the user guide source files in the Spock repository (likely in the docs folder). Identify where documentation for other utility packages is added and follow the same pattern. The issue specifically requests documentation for the spock.util.concurrent classes, which are only mentioned in the changelog. Look for existing examples in the user guide for similar packages and create a new section with explanations and usage examples for each class (e.g., BlockingVariable, PollingConditions). Ensure the documentation is consistent with the existing style.
Documentation for spock.util.concurrent classes · spockframework/spock#1058 | Good First Issue