Welcome! We are thrilled that you want to contribute to White Whale Migaloo Bots! 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 for the bots, 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:
-
An IDE. We recommend either Intellij Idea or VS Code,
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.
We use Github issues to manage issues in our bot 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.