google/comprehensive-rust

Look at mdbook-keeper

Open

#175 opened on 2023年1月17日

GitHub で見る
 (7 comments) (0 reactions) (0 assignees)Rust (2,009 forks)batch import
good first issue

Repository metrics

Stars
 (32,954 stars)
PR merge metrics
 (平均マージ 9d 23h) (30d で 36 merged PRs)

説明

We currently have a number of code blocks marked with compile_fail: this is often because they depend on third-party crates which aren't available when running mdbook test.

We should look into using https://github.com/tfpk/mdbook-keeper/ to handle testing instead. It explicitly supports using third-party crates in code snippets.

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

調査方針
mdbook keeper ツール（https://github.com/tfpk/mdbook keeper）を comprehensive rust コースの現在の compile fail コードブロックの代替として評価します。コードスニペット内のサードパーティクレートの処理方法に焦点を当て、既存の mdbook test アプローチとその設定や制限を比較し、結果を文書化します。リポジトリ内の既存の compile fail ブロックを確認して範囲を理解します。評価中に特定された質問やブロッカーについては、issue スレッドで議論してください。
技術スタック
rust
領域
documentationtesting
Issue 種別
調査
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Rustmdbook
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60