FuelLabs/sway

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

Open

#1,890 opened on Jun 7, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (5,421 forks)batch import
The Sway Bookgood first issue

Repository metrics

Stars
 (61,702 stars)
PR merge metrics
 (Avg merge 22h 6m) (16 merged PRs in 30d)

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.

Contributor guide

Research direction
Look through the `forc` CLI source code to find all command abbreviations (e.g., `forc b` for `forc build`) and add them to the Sway Book commands documentation.
Tech stack
rust
Domain
blockchain
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85