google/comprehensive-rust

Look at mdbook-keeper

Open

#175 ouverte le 17 janv. 2023

Voir sur GitHub
 (7 commentaires) (0 réactions) (0 assignés)Rust (2 009 forks)batch import
good first issue

Métriques du dépôt

Stars
 (32 954 stars)
Métriques de merge PR
 (Merge moyen 9j 23h) (36 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Évaluez l'outil mdbook keeper (https://github.com/tfpk/mdbook keeper) en tant que remplacement des blocs de code compile fail actuels dans le cours comprehensive rust. Concentrez vous sur la façon dont il gère les crates tierces dans les extraits de code, comparez sa configuration et ses limites avec l'approche de test mdbook existante, et documentez les résultats. Examinez les blocs compile fail existants dans le dépôt pour comprendre la portée. Discutez dans le fil de l'issue de toute question ou obstacle identifié lors de l'évaluation.
Stack technique
rust
Domaine
documentationtesting
Type d'issue
Recherche
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Rustmdbook
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60