FuelLabs/fuels-rs

Add docs for the fuel_types crate

Open

#1.300 aberto em 19 de mar. de 2024

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (1.360 forks)batch import
documentationgood first issue

Métricas do repositório

Stars
 (43.211 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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

Guia do colaborador

Direção de pesquisa
A issue solicita a adição de documentação para a crate fuel types, especificamente para tipos como bytes64. Comece examinando a crate fuel types no repositório fuels rs para entender os tipos existentes e seu uso. Concentre se em adicionar comentários de documentação a tipos e funções públicas e considere criar um guia curto ou documentação em nível de módulo. Verifique os comentários da issue para obter qualquer contexto adicional ou feedback específico do usuário. Certifique se de que a documentação seja consistente com o estilo usado em outras partes do SDK.
Pilha de tecnologia
rust
Domain
documentationdeveloper experience
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
basic Rustknowledge of fuel types crate
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80