FuelLabs/fuels-rs

Add docs for the fuel_types crate

Open

#1,300 opened on 2024年3月19日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Rust (43,211 stars) (1,360 forks)batch import
documentationgood first issue

説明

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

コントリビューターガイド

技術スタック
rust
領域
documentationdeveloper experience
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
basic Rustknowledge of fuel types crate
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
The issue requests adding documentation for the fuel types crate, specifically for types like bytes64. Start by examining the fuel types crate in the fuels rs repository to understand the existing types and their usage. Focus on adding doc comments to public types and functions, and consider creating a short guide or module level documentation. Look at the issue comments for any additional context or specific user feedback. Ensure the docs are consistent with the style used elsewhere in the SDK.
Add docs for the fuel_types crate · FuelLabs/fuels-rs#1300 | Good First Issue