FuelLabs/sway

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

Open

#1,890 建立於 2022年6月7日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Rust (5,421 fork)batch import
The Sway Bookgood first issue

倉庫指標

Star
 (61,702 star)
PR 合併指標
 (平均合併 22小時 6分鐘) (30 天內合併 16 個 PR)

描述

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.

貢獻者指南

研究方向
首先，透過執行 `forc help` 或查看原始碼中的命令定義（例如在 `forc/src/cli/` 目錄下），識別所有具有縮寫形式的 forc 命令。然後，找到 Sway Book 的文件檔案，很可能位於 `docs/book/src/commands/` 目錄下。對於每個命令，將縮寫（例如 `forc b` 對應 `forc build`）新增到相應的文件頁面。確保與現有格式保持一致。
技術棧
rust
領域
blockchain
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1 小時以內
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85