google/comprehensive-rust

Look at mdbook-keeper

Offen

#175 geöffnet am 17.01.2023

Auf GitHub ansehenContributor Guide
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (2.009 Forks)batch import
good first issue

Repository-Metriken

Stars
 (32.954 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Bewerten Sie das mdbook keeper Tool (https://github.com/tfpk/mdbook keeper) als Ersatz für die aktuellen compile fail Codeblöcke im comprehensive rust Kurs. Konzentrieren Sie sich darauf, wie es mit Drittanbieter Crates in Code Snippets umgeht, vergleichen Sie dessen Einrichtung und Einschränkungen mit dem bestehenden mdbook test Ansatz und dokumentieren Sie die Ergebnisse. Betrachten Sie die vorhandenen compile fail Blöcke im Repository, um den Umfang zu verstehen. Besprechen Sie im Issue Thread alle während der Bewertung identifizierten Fragen oder Hindernisse.
Tech Stack
rust
Domain
documentationtesting
Issue Type
Recherche
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rustmdbook
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60