catchorg/Catch2

The documentation needs updating for v3

Open

#2,050 opened on Oct 10, 2020

View on GitHub
 (7 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 4d 16h) (2 merged PRs 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 in the Catch2 repository. It likely resides in the 'docs' directory. Search for the string 'CATCH CONFIG MAIN' and replace it with the appropriate macro for v3, which is 'CATCH CONFIG MAIN' is deprecated; the new macro is 'CATCH CONFIG MAIN' not present in v3? Actually, Catch2 v3 uses 'CATCH CONFIG MAIN' is removed; use 'CATCH CONFIG MAIN'? Wait, better to check the v3 documentation or changelog. Look at the issue comments for discussion about the correct replacement. The fix should be straightforward: update the macro name and any related text to match the current v3 API.
Tech stack
cpp
Domain
documentation
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.
Stale
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