FuelLabs/fuels-rs

Add docs for the fuel_types crate

Open

#1.300 geöffnet am 19. März 2024

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Rust (1.360 Forks)batch import
documentationgood first issue

Repository-Metriken

Stars
 (43.211 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

This comes from a developer experience feedback made by a grantee user.

go to github fuel-rs and search for bytes64 you'll get one result then go and search in the docs - no results they're imported from use fuel_types::bytes64 and the proper crate should be imported

Contributor Guide

Research-Richtung
Das Issue fordert die Hinzufügung von Dokumentation für die fuel types crate, insbesondere für Typen wie bytes64. Beginnen Sie mit der Untersuchung der fuel types crate im fuels rs Repository, um die vorhandenen Typen und ihre Verwendung zu verstehen. Konzentrieren Sie sich darauf, Dokumentationskommentare zu öffentlichen Typen und Funktionen hinzuzufügen, und erwägen Sie die Erstellung eines kurzen Leitfadens oder einer Modul Level Dokumentation. Prüfen Sie die Issue Kommentare auf zusätzlichen Kontext oder spezifisches Nutzerfeedback. Stellen Sie sicher, dass die Dokumentation mit dem in anderen Teilen des SDK verwendeten Stil konsistent ist.
Tech Stack
rust
Domain
documentationdeveloper experience
Issue Type
Dokumentation
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.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
basic Rustknowledge of fuel types crate
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80