FuelLabs/fuels-rs

Add docs for the fuel_types crate

Open

#1 300 ouverte le 19 mars 2024

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Rust (1 360 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (43 211 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
La demande concerne l'ajout de documentation pour la crate fuel types, en particulier pour des types comme bytes64. Commencez par examiner la crate fuel types dans le dépôt fuels rs pour comprendre les types existants et leur utilisation. Concentrez vous sur l'ajout de commentaires de documentation aux types et fonctions publics, et envisagez de créer un guide court ou une documentation au niveau du module. Consultez les commentaires de la demande pour tout contexte supplémentaire ou retour d'utilisateur spécifique. Assurez vous que la documentation est cohérente avec le style utilisé ailleurs dans le SDK.
Stack technique
rust
Domaine
documentationdeveloper experience
Type d'issue
Documentation
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.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
basic Rustknowledge of fuel types crate
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80