FuelLabs/sway

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

Offen

#1.890 geöffnet am 07.06.2022

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Rust (5.421 Forks)batch import
The Sway Bookgood first issue

Repository-Metriken

Stars
 (61.702 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 22h 6m) (16 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Identifiziere zunächst alle forc Befehle, die Kurzform Abkürzungen haben, indem du `forc help` ausführst oder die Befehlsdefinitionen im Quellcode überprüfst (z. B. in `forc/src/cli/`). Finde dann die Dokumentationsdateien für das Sway Book, wahrscheinlich unter `docs/book/src/commands/`. Füge für jeden Befehl die Abkürzung (z. B. `forc b` für `forc build`) zur entsprechenden Dokumentationsseite hinzu. Stelle die Konsistenz mit dem vorhandenen Format sicher.
Tech Stack
rust
Domain
blockchain
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85