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