catchorg/Catch2

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

Open

#2,312 opened on 2021年10月27日

GitHub で見る
 (6 comments) (0 reactions) (0 assignees)C++ (3,228 forks)batch import
DocumentationGood First Issue

Repository metrics

Stars
 (20,381 stars)
PR merge metrics
 (平均マージ 4d 16h) (30d で 2 merged PRs)

説明

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.

コントリビューターガイド

調査方針
リポジトリ内のファイル `docs/own main.md` を探します。Clara のリポジトリへのリンクがある行を見つけます。Clara の新しいドキュメントページ（おそらく `docs/clara.md`）を作成する場所を決定します。リンクを新しいページを指すように更新します。新しいページに、Catch2 内で使用される Clara パーサーに関する適切なドキュメントが含まれていることを確認します。
技術スタック
cpp
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Basic knowledge of MarkdownFamiliarity with Catch2's docs structure
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90