FuelLabs/sway

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

Open

#1890 aperta il 7 giu 2022

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Rust (5421 fork)batch import
The Sway Bookgood first issue

Metriche repository

Star
 (61.702 star)
Metriche merge PR
 (Merge medio 22h 6m) (16 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Per prima cosa, identifica tutti i comandi forc che hanno abbreviazioni eseguendo `forc help` o esaminando le definizioni dei comandi nel codice sorgente (ad esempio in `forc/src/cli/`). Quindi, individua i file di documentazione per il Sway Book, probabilmente in `docs/book/src/commands/`. Per ogni comando, aggiungi l'abbreviazione (ad esempio `forc b` per `forc build`) alla pagina di documentazione corrispondente. Assicurati la coerenza con il formato esistente.
Tech stack
rust
Dominio
blockchain
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85