FuelLabs/sway

Update the Sway Book to document the abbreviations for any `forc` commands.

Aberta

#1.890 aberto em 7 de jun. de 2022

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)Rust (5.421 forks)batch import
The Sway Bookgood first issue

Métricas do repositório

Stars
 (61.702 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Context

The Sway Book has a commands section for forc. When taking a look at forc build and forc test they do not document the shorthand e.g.

  1. forc build can be used as forc b
  2. forc test can be used as forc t

There may be other shorthand commands that have been added but are undocumented.

Guia do colaborador

Direção de pesquisa
Primeiro, identifique todos os comandos forc que possuem abreviações executando `forc help` ou revisando as definições de comando no código fonte (por exemplo, em `forc/src/cli/`). Em seguida, localize os arquivos de documentação do Sway Book, provavelmente em `docs/book/src/commands/`. Para cada comando, adicione a abreviação (por exemplo, `forc b` para `forc build`) à página de documentação correspondente. Garanta consistência com o formato existente.
Pilha de tecnologia
rust
Domain
blockchain
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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85