Welcome! We are thrilled that you want to contribute to White Whale Migaloo! Consider that there are many ways in which you can contribute, it's not only about writing code. In this document we go through different ways you can get involved with the project.
If you are a software developer and want to contribute writing code, the first step is to get familiar with the Migaloo architecture, which you can learn about in our docs.
Before you can write any code, please take a look at the list of prerequisites below.
To download the necessary tools, clone the repository and so on, you need network access.
The following are the tools you'll need:
- Git
- Rust
- wasm32 target set for Rust
- PyO3, which requires a Python installation with a shared library (see https://github.com/PyO3/pyo3/tree/main#using-python-from-rust for example instructions on installing this for Ubuntu)
- Just
$ rustup default stable
$ cargo version
# If this is lower than 1.64.0, update
$ rustup update stable
$ rustup target list --installed
$ rustup target add wasm32-unknown-unknown
# for generating contract
$ cargo install cargo-generate --features vendored-openssl
$ cargo install cargo-run-script- An IDE. We recommend either Intellij Idea or VS Code, but feel free to use your preferred code editor.
- Intellij Rust plugin, if you use Intellij.
- VS Code Rust plugin, if you use VS Code.
- Docker, used to run the rust optimizer, i.e. compile the contracts for production.
- Go (optional), in case you want to use
wasmd,terrad,junodor alike.
Then fork the code and read it through. We encourage you to make your own contributions, though you might look at the issue tracker if you want to solve something that has been pointed out already.
Make a pull request to our repository once your work is complete. We will review it and discuss potential changes before we merge it to the main code base.
The following are the steps to fork the repository to your GitHub account and clone it to your local machine.
- Fork the repository.
- Go to Migaloo's Core repository, i.e. Migaloo-Core.
- Click on the "fork" button located in the top right corner of the page.
- Click on your GitHub account where you want to fork the repo.
- Clone your fork to your local machine, preferably using the SSH URL. If you have issues cloning this repo, look at the
GitHub docs. -
git clone [email protected]:$USER/migaloo-core.gitorgit clone https://github.com/$USER/migaloo-core.git - Set up your git user locally if you haven't already.
git config --global user.name "your name or alias"git config --global user.email "your email address"
- Install our pre-commit hook. Do not skip this step. This will make sure that your code doesn't have any issues and
is formatted correctly before you even commit. If you don't install this, you risk your future pull request to fail on CI,
which you will need to fix before we review it. -
./scripts/hooks/pre-commit.sh --install - Review CLI commands that can be used when developing in the repository by running
just - Make your contributions locally. The following are recommendations so that it is easier for anyone to understand what you are trying to achieve: - Please use conventional commits syntax. - Please make sure to use clear commit messages. - Please favor small commits instead of large ones.
- Make sure to update the schemas if you have modified the messages.
just schemas
- If you made protobuf changes, regenerate the appropriate protobuf rust files using
protoc-gen-rust - Make sure your code compiles, both for debug and production.
cargo buildcargo wasm./scripts/build_release.sh
- Test your code. We strive for high quality code, so any changes you introduce need to be tested. We know testing contracts
can be difficult! If you are not sure how to create tests, please refer to existing ones or just ask us on our
discord. Please note that Untested code will be rejected -
cargo test - Setup and use the provided githooks! These help speed up the review process pointing out common issues before a CI check like lints. To install the hook, run
scripts/hooks/pre-commit.sh --install - Push your changes to your repository.
git push --set-upstream $YOUR_ORIGIN $YOUR_BRANCH_NAME
- Create a pull request. Go to your repository and create a pull request against Migaloo's repository main branch as base. - Please fill in the template presented to you when creating the pull request, as it helps everybody understand what the PR is trying to achieve. - Follow the instructions on the PR template. Consider that a pull request that doesn't follow the template or is not filled in properly will be considered incomplete.
- Follow up the discussions on the PR as there might be requests from other members.
- Wait for your PR to be approved and merged.
We use Github issues to manage issues in our code. You can help out by resolving or commenting on existing issues or creating new issues for what you find. Whether you want to report an issue or have a feature request, please fill the issue template and provide as much information as possible.
Before you create a new issue, please search through the open issues and make sure the issue or feature request has not been made by someone else already.
If the issue or feature request already exists, please add a 👍 reaction to show your support and leave your comments on it, that way we can prioritize accordingly.
Code quality and security are two things we take seriously at White Whale. We strive for having high test coverage, and we make sure our code is safe by auditing via third party security firms. Nevertheless, we believe there's always room for improvement.
If you find a critical vulnerability, please do not report it publicly on the Github issues tracker. Instead, reach out to us in private where we will discuss it in details.
See how to report security bugs.
If you are interested in developer relations, a great way to contribute is answering people's questions on our Discord, Twitter or Telegram channels, creating documentation in our Wiki, creating medium articles or even creating YouTube tutorials on how to use our flashloans!
White Whale is a community project, we are curious to hear your ideas for the future of Migaloo! One way to provide feedback is by doing to our Discord channel. You can also submit a suggestion or feature request through Github's issue tracker. When doing so, make sure to describe your idea as good as possible so that we understand what you envision.
Are you a graphic designer and want to help out with some NFTs? Are you a copywriter seeing potential improvements in our communications? Whatever it is, we would love to hear from you and see how we can make White Whale better for everybody.
When in doubt, please take a look at our litepaper or our documentation.
All contributions to White Whale are of great value and make this protocol possible. Thanks for taking the time to make White Whale better! We really appreciate it.