google/comprehensive-rust

Look at mdbook-keeper

开放

#175 创建于 2023年1月17日

在 GitHub 查看贡献者指南
 (7 条评论) (0 个反应) (0 位负责人)Rust (2,009 个派生)batch import
good first issue

仓库指标

星标
 (32,954 个星标)
PR 合并指标
 (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