google/comprehensive-rust

Look at mdbook-keeper

Open

#175 aberto em 17 de jan. de 2023

Ver no GitHub
 (7 comments) (0 reactions) (0 assignees)Rust (2.009 forks)batch import
good first issue

Métricas do repositório

Stars
 (32.954 stars)
Métricas de merge de PR
 (Mesclagem média 9d 23h) (36 fundiu PRs em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Avalie a ferramenta mdbook keeper (https://github.com/tfpk/mdbook keeper) como substituto para os atuais blocos de código compile fail no curso comprehensive rust. Foque em como ela lida com crates de terceiros nos trechos de código, compare sua configuração e limitações com a abordagem de teste mdbook existente e documente as descobertas. Examine os blocos compile fail existentes no repositório para entender o escopo. Discuta no tópico da issue quaisquer perguntas ou bloqueadores identificados durante a avaliação.
Pilha de tecnologia
rust
Domain
documentationtesting
Tipo Issue
Pesquisa
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Rustmdbook
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60