catchorg/Catch2

Replace link to Clara's repository for doc with our own documentation page

Open

#2312 aperta il 27 ott 2021

Vedi su GitHub
 (6 commenti) (0 reazioni) (0 assegnatari)C++ (3228 fork)batch import
DocumentationGood First Issue

Metriche repository

Star
 (20.381 star)
Metriche merge PR
 (Merge medio 4g 16h) (2 PR mergiate in 30 g)

Descrizione

Clara, the command line parser library in Catch2, stopped being a separate project from Catch2 about 3 years ago. Since then it was only developed inside Catch2, while the original upstream repository was made inactive and archived.

Given that Clara-inside-Catch2 has also slowly diverged from the separate version, we should provide its documentation inside the Catch2 repo, and replace the link to upstream docs in the own-main docs with link to our own documentation page for Clara.

Guida contributor

Direzione di ricerca
Individua il file `docs/own main.md` nel repository. Trova la riga che collega al repository di Clara. Determina dove creare una nuova pagina di documentazione per Clara (probabilmente `docs/clara.md`). Aggiorna il collegamento in modo che punti alla nuova pagina. Assicurati che la nuova pagina contenga la documentazione appropriata per il parser Clara come utilizzato all'interno di Catch2.
Tech stack
cpp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Basic knowledge of MarkdownFamiliarity with Catch2's docs structure
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90