Thanks for your interest in contributing to Sway! This document outlines the process for installing and setting up the Sway toolchain for development, as well as some conventions on contributing to Sway.
If you run into any difficulties getting started, you can always ask questions on our Discourse .
See the introduction section for instructions on installing and setting up the Sway toolchain.
git clone https://github.com/FuelLabs/sway cd sway
The following steps will run the sway test suite and ensure that everything is set up correctly.
First, open a new terminal and start
Then open a second terminal, cd into the
sway repo and run:
cargo run --bin test
After the test suite runs, you should see:
Tests passed. _n_ tests run (0 skipped)
Congratulations! You've now got everything setup and are ready to start making contributions.
There are many ways in which you may contribute to the Sway project, some of which involve coding knowledge and some which do not. A few examples include:
If you are planning something big, for example, related to multiple components or changes current behaviors, make sure to open an issue to discuss with us before starting on the implementation.
This is a rough outline of what a contributor's workflow looks like:
Thanks for your contributions!
Pull requests should be linked to at least one issue in the same repo.
If the pull request resolves the relevant issues, and you want GitHub to close these issues automatically after it merged into the default branch, you can use the syntax (
KEYWORD #ISSUE-NUMBER) like this:
If the pull request links an issue but does not close it, you can use the keyword
ref like this:
Multiple issues should use full syntax for each issue and separate by a comma, like:
close #123, ref #456