FuelLabs/fuels-rs

Add docs for the fuel_types crate

Open

#1,300 opened on Mar 19, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (1,360 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (43,211 stars)
PR merge metrics
 (Avg merge 17d) (1 merged PR in 30d)

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

Contributor guide

Research direction
Familiarize yourself with the fuel types crate, locate the bytes64 type, and add Rustdoc comments with usage examples. Ensure documentation builds correctly with 'cargo doc'. Check existing patterns in the fuels rs repo for consistency.
Tech stack
rust
Domain
blockchaindocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85