google/comprehensive-rust

Look at mdbook-keeper

Open

#175 建立於 2023年1月17日

在 GitHub 查看
 (7 留言) (0 反應) (0 負責人)Rust (2,009 fork)batch import
good first issue

倉庫指標

Star
 (32,954 star)
PR 合併指標
 (平均合併 9天 23小時) (30 天內合併 36 個 PR)

描述

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 程式碼區塊的替代方案。重點關注其如何處理程式碼片段中的第三方 crate，將其設定和限制與現有的 mdbook test 方法進行比較，並記錄發現。查看儲存庫中現有的 compile fail 區塊以了解範圍。在 issue 討論中提出評估過程中發現的任何問題或阻礙。
技術棧
rust
領域
documentationtesting
議題類型
調研
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Rustmdbook
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60