testcontainers/testcontainers-java

New docs: Startup strategy information/examples

Open

#1,157 opened on Jan 19, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Java (1,588 forks)batch import
help wantedtype/docs

Repository metrics

Stars
 (7,535 stars)
PR merge metrics
 (Avg merge 2d 17h) (2 merged PRs in 30d)

Description

Improvement for the new mkdocs-based documentation.

Add a section 'Startup Strategies' to docs/features/startup_and_waits.md describing the default and 'one-shot' strategies, with a codeincluded example for the latter.

Contributor guide

Research direction
Read the existing docs/features/startup and waits.md file to understand its structure. Then add a new section titled 'Startup Strategies' that explains the default and 'one shot' strategies, and include a code example for the 'one shot' strategy.
Tech stack
java
Domain
developer experience
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
JavaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75