感谢您对 Sway 的贡献兴趣!本文档概述了安装和设置 Sway 工具链进行开发的过程,以及一些贡献到 Sway 的约定。
如果在开始时遇到任何困难,您可以在我们的 Discourse 上提问。
请参阅 introduction 部分中的说明,了解如何安装和设置 Sway 工具链。
git clone https://github.com/FuelLabs/sway
cd sway
以下步骤将运行 Sway 测试套件并确保一切设置正确。
首先,打开一个新终端并启动 fuel-core
:
fuel-core
然后打开第二个终端,cd
到 sway
存储库并运行:
cargo run --bin test
测试套件运行后,您应该会看到:
Tests passed.
_n_ tests run (0 skipped)
恭喜!您现在已经设置好一切,并且准备开始做出贡献。
有许多方式可以为 Sway 项目做出贡献,其中一些涉及编码知识,而另一些则不涉及。一些示例包括:
查看我们的 Help Wanted 、Sway Book 或 Good First Issue 问题,找到适合的任务。
如果您计划做一些大的事情,例如与多个组件相关或更改当前行为,请确保在开始实施之前打开问题与我们讨论。
以下是贡献者工作流程的大致概述:
感谢您的贡献!
拉取请求应链接到同一存储库中的至少一个问题。
如果拉取请求解决了相关问题,并且您希望 GitHub 在合并到默认分支后自动关闭这些问题,您可以使用如下语法(关键词 #问题编号
):
close #123
如果拉取请求链接了一个问题但未关闭它,您可以使用关键词 ref
,像这样:
ref #456
多个问题应该对每个问题使用完整的语法,并用逗号分隔,如:
close #123, ref #456