Skip to content

Commit

Permalink
docs(contributing): add protobuf step, reference PyO3
Browse files Browse the repository at this point in the history
  • Loading branch information
@kaimen-sano
kaimen-sano committed Jan 7, 2024
1 parent d22510d commit 37473ba
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 66 deletions.
28 changes: 14 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
## Description and Motivation

<!--
Please write a description of what this PR is changing, removing or adding, and why. Consider including before/after
<!--
Please write a description of what this PR is changing, removing or adding, and why. Consider including before/after
comparisons.
-->

## Related Issues

<!--
<!--
Add the list of issues related to this PR from the [issue tracker](https://github.com/White-Whale-Defi-Platform/migaloo-core/issues).
Indicate, which of these issues are resolved or fixed by this PR, like #XXXX, where XXXX is the issue number.
-->


---

## Checklist:

<!--
<!--
Thanks for contributing to White Whale Migaloo!
Before you file this pull request, please follow the items on this checklist and put an x in each of the boxes,
like this: [x].
Thanks for contributing to White Whale Migaloo!
Before you file this pull request, please follow the items on this checklist and put an x in each of the boxes,
like this: [x].
Make sure to follow the guidelines, so we can process this PR as fast as possible.
Make sure to follow the guidelines, so we can process this PR as fast as possible.
-->

- [ ] I have read [Migaloo's contribution guidelines](https://github.com/White-Whale-Defi-Platform/migaloo-core/blob/main/CONTRIBUTING.md).
- [ ] I have read [Migaloo's contribution guidelines](https://github.com/White-Whale-Defi-Platform/migaloo-core/blob/main/docs/CONTRIBUTING.md).
- [ ] My pull request has a sound title and description (not something vague like `Update index.md`)
- [ ] All existing and new tests are passing.
- [ ] I updated/added relevant documentation.
Expand Down
102 changes: 50 additions & 52 deletions docs/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@

# Contributing to Migaloo

Welcome! We are thrilled that you want to contribute to White Whale Migaloo! Consider that there are many ways in which you can contribute,
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.

## Crafting Code

If you are a software developer and want to contribute writing code, the first step is to get familiar with
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](https://white-whale-defi-platform.github.io/docs/).

Before you can write any code, please take a look at the list of prerequisites below.
Before you can write any code, please take a look at the list of prerequisites below.

### Prerequisites

To download the necessary tools, clone the repository and so on, you need network access.

The following are the tools you'll need:
- [Git](https://git-scm.com/)

- [Git](https://git-scm.com/)
- [Rust](https://rustup.rs/)
- wasm32 target
- [PyO3](https://pyo3.rs), 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)

```bash
$ rustup default stable
$ cargo version
Expand All @@ -32,99 +34,94 @@ $ rustup target add wasm32-unknown-unknown
$ cargo install cargo-generate --features vendored-openssl
$ cargo install cargo-run-script
```
- An IDE. We recommend either [Intellij Idea](https://www.jetbrains.com/idea/download/) or [VS Code](https://code.visualstudio.com/download),
but feel free to use your preferred code editor.

- An IDE. We recommend either [Intellij Idea](https://www.jetbrains.com/idea/download/) or [VS Code](https://code.visualstudio.com/download),
but feel free to use your preferred code editor.
- [Intellij Rust plugin](https://plugins.jetbrains.com/plugin/8182-rust), if you use Intellij.
- [VS Code Rust plugin](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust), if you use VS Code.
- [Docker](https://www.docker.com/), used to run the rust optimizer, i.e. compile the contracts for production.
- [Go](https://go.dev/doc/install) (optional), in case you want to use `wasmd`, `terrad`, `junod` or 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](https://github.com/White-Whale-Defi-Platform/migaloo-core/issues) if you want to solve something that has
---

Then fork the code and read it through. We encourage you to make your own contributions, though you might look at the
[issue tracker](https://github.com/White-Whale-Defi-Platform/migaloo-core/issues) 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.

### Forking the repository
### Forking the repository

The following are the steps to fork the repository to your GitHub account and clone it to your local machine.

1. Fork the repository.
- Go to Migaloo's Core repository, i.e. [Migaloo-Core](https://github.com/White-Whale-Defi-Platform/migaloo-core).
- Click on the ["fork" button](https://github.com/White-Whale-Defi-Platform/migaloo-core/fork) located in the top
right corner of the page.
- Click on your GitHub account where you want to fork the repo.
2. Clone your fork to your local machine, preferably using the SSH URL. If you have issues cloning this repo, look at the
[GitHub docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
- `git clone git@github.com:$USER/migaloo-core.git` or `git clone https://github.com/$USER/migaloo-core.git`
- Go to Migaloo's Core repository, i.e. [Migaloo-Core](https://github.com/White-Whale-Defi-Platform/migaloo-core).
- Click on the ["fork" button](https://github.com/White-Whale-Defi-Platform/migaloo-core/fork) located in the top
right corner of the page.
- Click on your GitHub account where you want to fork the repo.
2. Clone your fork to your local machine, preferably using the SSH URL. If you have issues cloning this repo, look at the
[GitHub docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). - `git clone git@github.com:$USER/migaloo-core.git` or `git clone https://github.com/$USER/migaloo-core.git`
3. 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"`
- `git config --global user.name "your name or alias"`
- `git config --global user.email "your email address"`
4. 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`
5. 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](https://conventionalcommits.org) syntax.
- Please make sure to use clear commit messages.
- Please favor small commits instead of large ones.
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`
5. 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](https://conventionalcommits.org) syntax. - Please make sure to use clear commit messages. - Please favor small commits instead of large ones.
6. Make sure to update the schemas if you have modified the messages.
- `cargo schema`
7. Make sure your code compiles, both for debug and production.
- `cargo build`
- `cargo wasm`
- `./scripts/build_release.sh`
8. 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](https://discordapp.com/channels/908044702794801233/987301947440767006). Please note that **Untested code will be rejected**
- `cargo test`
- `cargo schema`
7. If you made protobuf changes, regenerate the appropriate protobuf rust files using [`protoc-gen-rust`](https://docs.rs/protobuf-codegen/latest/protobuf_codegen/#how-to-use-protoc-gen-rust)
8. Make sure your code compiles, both for debug and production.
- `cargo build`
- `cargo wasm`
- `./scripts/build_release.sh`
9. 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](https://discordapp.com/channels/908044702794801233/987301947440767006). Please note that **Untested code will be rejected** - `cargo test`
10. 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`
11. Push your changes to your repository.
- `git push --set-upstream $YOUR_ORIGIN $YOUR_BRANCH_NAME`
12. Create a pull request. Go to your [repository](https://github.com/$USER/migaloo-core.git) 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*.
12. Create a pull request. Go to your [repository](https://github.com/$USER/migaloo-core.git) 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_.
13. Follow up the discussions on the PR as there might be requests from other members.
14. Wait for your PR to be approved and merged.

## Helping out in the issue tracker

We use [Github issues](https://github.com/White-Whale-Defi-Platform/migaloo-core/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
We use [Github issues](https://github.com/White-Whale-Defi-Platform/migaloo-core/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.

### Look For an Existing Issue

Before you create a new issue, please search through the open issues and make sure the issue or feature request has not
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.

## Quality Assurance

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.
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
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](https://github.com/White-Whale-Defi-Platform/migaloo-core/blob/main/SECURITY.md).

## Engaging with the community

If you are interested in developer relations, a great way to contribute is answering people's questions on our
[Discord](https://discord.com/invite/tSxyyCWgYX), [Twitter](https://twitter.com/WhiteWhaleDefi) or [Telegram](https://t.me/whitewhaleofficial)
If you are interested in developer relations, a great way to contribute is answering people's questions on our
[Discord](https://discord.com/invite/tSxyyCWgYX), [Twitter](https://twitter.com/WhiteWhaleDefi) or [Telegram](https://t.me/whitewhaleofficial)
channels, creating documentation in our Wiki, creating medium articles or even creating YouTube tutorials on how to use our flashloans!

## Providing Suggestions

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](https://discordapp.com/channels/908044702794801233/908044703373606954). You can also
submit a suggestion or feature request through [Github's issue tracker](https://github.com/White-Whale-Defi-Platform/migaloo-core/issues).
submit a suggestion or feature request through [Github's issue tracker](https://github.com/White-Whale-Defi-Platform/migaloo-core/issues).
When doing so, make sure to describe your idea as good as possible so that we understand what you envision.

## Bringing your expertise
Expand All @@ -133,9 +130,10 @@ Are you a graphic designer and want to help out with some NFTs? Are you a copywr
Whatever it is, we would love to hear from you and see how we can make White Whale better for everybody.

## Docs
When in doubt, please take a look at our [litepaper](https://whitewhale.money/LitepaperV2.pdf) or our [documentation]([https://white-whale-defi-platform.github.io/docs/](https://ww0-1.gitbook.io/migaloo-docs/)).

When in doubt, please take a look at our [litepaper](https://whitewhale.money/LitepaperV2.pdf) or our [documentation](<[https://white-whale-defi-platform.github.io/docs/](https://ww0-1.gitbook.io/migaloo-docs/)>).

# Thank you!

All contributions to White Whale are of great value and make this protocol possible. Thanks for taking the time to make
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.

0 comments on commit 37473ba

Please sign in to comment.