catchorg/Catch2

The documentation needs updating for v3

Open

#2,050 opened on Oct 10, 2020

View on GitHubContributor guide
 (9 comments) (0 reactions) (0 assignees)C++ (3,228 forks)batch import
DocumentationGood First Issue

Repository metrics

Stars
 (20,381 stars)
PR merge metrics
 (Avg merge 1d 8h) (1 merged PR in 30d)

Description

As an example, the "Getting started" documentation still talks about CATCH_CONFIG_MAIN macro.

Contributor guide

Research direction
Locate the 'Getting started' documentation file that references CATCH CONFIG MAIN and update it to reflect v3 changes, likely replacing that macro with the new configuration method.
Tech stack
None
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.
Under 1 hour
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.
90