FuelLabs/sway

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

Open

#1 890 ouverte le 7 juin 2022

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Rust (5 421 forks)batch import
The Sway Bookgood first issue

Métriques du dépôt

Stars
 (61 702 stars)
Métriques de merge PR
 (Merge moyen 22h 6m) (16 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Tout d'abord, identifiez toutes les commandes forc qui ont des abréviations en exécutant `forc help` ou en examinant les définitions des commandes dans le code source (par exemple dans `forc/src/cli/`). Ensuite, localisez les fichiers de documentation du Sway Book, probablement sous `docs/book/src/commands/`. Pour chaque commande, ajoutez l'abréviation (par exemple `forc b` pour `forc build`) à la page de documentation correspondante. Assurez vous de la cohérence avec le format existant.
Stack technique
rust
Domaine
blockchain
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85