diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 0e5f772f..76f973e7 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,3 +1,3 @@ # @Sen-Com is the repository administrator who ensures compliance with the White Whale Repository Guideline. # The remaining code owners help maintain the repository. -* @Sen-Com @kerber0x @0xFable \ No newline at end of file +* @PolkachuIntern @faddat @Sen-Com @kerber0x @0xFable \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/1_bug.md b/.github/ISSUE_TEMPLATE/1_bug.md index 952c7d3c..db42d1d1 100644 --- a/.github/ISSUE_TEMPLATE/1_bug.md +++ b/.github/ISSUE_TEMPLATE/1_bug.md @@ -11,9 +11,9 @@ assignees: '' If you are looking for support, please check out our documentation or consider asking a question on Discord: - * https://whitewhale.money/ + * https://migaloo.zone/ * https://white-whale-defi-platform.github.io/docs/ - * https://discordapp.com/channels/908044702794801233/987301947440767006 + * https://discord.com/channels/908044702794801233/1069611972053712947 If you have found a bug or if our documentation doesn't have an answer to what you're looking for, then fill out the template below. diff --git a/.github/ISSUE_TEMPLATE/2_improvement.md b/.github/ISSUE_TEMPLATE/2_improvement.md index 4db7170c..1c76f42f 100644 --- a/.github/ISSUE_TEMPLATE/2_improvement.md +++ b/.github/ISSUE_TEMPLATE/2_improvement.md @@ -11,9 +11,9 @@ assignees: '' If you are looking for support, please check out our documentation or consider asking a question on Discord: - * https://whitewhale.money/ + * https://migaloo.zone/ * https://white-whale-defi-platform.github.io/docs/ - * https://discordapp.com/channels/908044702794801233/987301947440767006 + * https://discord.com/channels/908044702794801233/1069611972053712947 If you have found a bug or if our documentation doesn't have an answer to what you're looking for, then fill out the template below. diff --git a/.github/ISSUE_TEMPLATE/3_feature_request.md b/.github/ISSUE_TEMPLATE/3_feature_request.md index 97a6980b..02f50479 100644 --- a/.github/ISSUE_TEMPLATE/3_feature_request.md +++ b/.github/ISSUE_TEMPLATE/3_feature_request.md @@ -11,9 +11,9 @@ assignees: '' If you are looking for support, please check out our documentation or consider asking a question on Discord: - * https://whitewhale.money/ + * https://migaloo.zone/ * https://white-whale-defi-platform.github.io/docs/ - * https://discordapp.com/channels/908044702794801233/987301947440767006 + * https://discord.com/channels/908044702794801233/1069611972053712947 If you have found a bug or if our documentation doesn't have an answer to what you're looking for, then fill out the template below. diff --git a/.github/ISSUE_TEMPLATE/4_infrastructure.md b/.github/ISSUE_TEMPLATE/4_infrastructure.md index e24830b5..1f9c6882 100644 --- a/.github/ISSUE_TEMPLATE/4_infrastructure.md +++ b/.github/ISSUE_TEMPLATE/4_infrastructure.md @@ -11,9 +11,9 @@ assignees: '' If you are looking for support, please check out our documentation or consider asking a question on Discord: - * https://whitewhale.money/ + * https://migaloo.zone/ * https://white-whale-defi-platform.github.io/docs/ - * https://discordapp.com/channels/908044702794801233/987301947440767006 + * https://discord.com/channels/908044702794801233/1069611972053712947 If you have found a bug or if our documentation doesn't have an answer to what you're looking for, then fill out the template below. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a14feac0..085ec503 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: true contact_links: - - name: I want help using Migaloo Chain + - name: I want help using Migaloo url: https://discordapp.com/channels/908044702794801233/987301947440767006 - about: Ask any questions related to using or integrating with Migaloo Chain, deploying your decentralized applications and so on. + about: Ask any questions related to using or integrating with Migaloo, deploying your decentralized applications and so on. diff --git a/README.md b/README.md index 9b764232..f87a8199 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ ![](https://user-images.githubusercontent.com/94062656/215557558-6d0c39f1-9405-439a-aeb5-9baccdbd9df8.png) - Migaloo Chain is the home of the White Whale. This chain began as a fork of wasmd, and is an exploration into better CosmWasm enabled chain templates that more @@ -13,16 +12,20 @@ We kept the git history, because that's the way :). ## Resources -1. [Website]() -2. [LitePaper]() -3. [Docs]() +1. [Website](https://migaloo.zone) +2. [LitePaper]() - Coming Soon +3. [Docs]() - Coming Soon 4. [Roadmap](./docs/ROADMAP.md) -5. [Discord]() -6. [Twitter]() -7. [Telegram]() +5. [Discord](https://discord.com/channels/908044702794801233/1069611972053712947) +6. [Twitter](https://twitter.com/WhiteWhaleDefi) +7. [Telegram](https://t.me/whitewhaleofficial) ## System Requirements - +- Operating System: Linux or macOS +- Disk Space: At least 100GB of free space is recommended. +- CPU: Multi-core processor, 4+ cores recommended +- RAM: 8GB+ recommended +- Network: Good internet connectivity ## Quick start @@ -45,7 +48,7 @@ migalood version ## Learn More -- [White Whale Migaloo Protocol](https://whitewhale.money/) +- [White Whale Protocol](https://whitewhale.money/) - [Cosmos SDK documentation](https://docs.cosmos.network/) - [Cosmos SDK Tutorials](https://tutorials.cosmos.network/) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index b61c8a81..2095b4a0 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -19,8 +19,9 @@ The following are the tools you'll need: - [Git](https://git-scm.com/) - [Go](https://go.dev/doc/install) - [Docker](https://www.docker.com/) -- An IDE. We recommend either [Intellij Idea](https://www.jetbrains.com/idea/download/) or [VS Code](https://code.visualstudio.com/download), +- An IDE. We recommend either [GoLand](https://www.jetbrains.com/go/download/), [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. +- [Go Plugin](https://plugins.jetbrains.com/plugin/9568-go) for Intellij Idea or the [Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go) for VS Code. --- Then fork the code and read it through. We encourage you to make your own contributions, though you might look at the @@ -45,31 +46,26 @@ The following are the steps to fork the repository to your GitHub account and cl 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"` -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 +4. 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 your code compiles, both for debug and production. - - `cargo build` - - `cargo wasm` - - `./scripts/build_release.sh` -7. Test your code. We strive for high quality code, so any changes you introduce need to be tested. We know testing contracts +5. Make sure your code compiles. + - `make build` + - `go build ./...` +6. 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** - - `go test` -8. Push your changes to your repository. + [discord](https://discord.com/channels/908044702794801233/1069611972053712947). Please note that **Untested code will be rejected** + - `go test ./...` +7. Push your changes to your repository. - `git push --set-upstream $YOUR_ORIGIN $YOUR_BRANCH_NAME` -9. Create a pull request. Go to your [repository](https://github.com/$USER/migaloo-chain.git) and create a pull request +8. Create a pull request. Go to your [repository](https://github.com/$USER/migaloo-chain.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*. -10. Follow up the discussions on the PR as there might be requests from other members. -11. Wait for your PR to be approved and merged. +9. Follow up the discussions on the PR as there might be requests from other members. +10. Wait for your PR to be approved and merged. ## Helping out in the issue tracker @@ -97,13 +93,13 @@ See how to [report security bugs](https://github.com/White-Whale-Defi-Platform/m ## Engaging with the community 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 or even medium articles!. +[Discord](https://discord.com/channels/908044702794801233/1069611972053712947), [Twitter](https://twitter.com/WhiteWhaleDefi) +or [Telegram](https://t.me/whitewhaleofficial) channels, creating documentation or even medium articles!. ## Providing Suggestions Migaloo is a community project, we are curious to hear your ideas for the future of it! One way to provide feedback -is by doing to our [Discord channel](). You can also +is by doing to our [Discord channel](https://discord.com/channels/908044702794801233/1069611972053712947). You can also submit a suggestion or feature request through [Github's issue tracker](https://github.com/White-Whale-Defi-Platform/migaloo-chain/issues). When doing so, make sure to describe your idea as good as possible so that we understand what you envision. diff --git a/docs/SECURITY.md b/docs/SECURITY.md index e45bba8b..b444608a 100644 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -8,10 +8,11 @@ This document outlines security procedures and general policies for the `migaloo Security is something we take seriously at Migaloo. Thanks for taking the time to improve the security of `migaloo-chain`. We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions. -Please report security bugs by emailing White Whale at security@whitewhale.money. Do not report it publicly on the GitHub -issues tracker. Your report should detail the necessary steps to reproduce the security issue. We will acknowledge your -email within 48 hours and send a detailed response indicating the next steps. After the initial reply to your report, -we will keep you informed of the progress towards a fix and full announcement and may ask for additional information or guidance. +Please report security bugs by emailing White Whale at security@whitewhale.money or contact@notional.ventures. Do not report +it publicly on the GitHub issues tracker. Your report should detail the necessary steps to reproduce the security issue. +We will acknowledge your email within 48 hours and send a detailed response indicating the next steps. After the initial +reply to your report, we will keep you informed of the progress towards a fix and full announcement and may ask for +additional information or guidance. Report security bugs in third-party modules to the person or team maintaining the module.