diff --git a/.github/workflows/linkchecker.yml b/.github/workflows/linkchecker.yml index bc4c3ad..a302a08 100644 --- a/.github/workflows/linkchecker.yml +++ b/.github/workflows/linkchecker.yml @@ -4,7 +4,7 @@ on: pull_request: push: branches: - - master + - main - develop schedule: - cron: '* */24 * * *' diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index bb99c0e..6493d00 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,12 +1,12 @@ name: Lint # Lint runs golangci-lint over the entire cosmos-sdk repository -# This workflow is run on every pull request and push to master +# This workflow is run on every pull request and push to main # The `golangci` will pass without running if no *.{go, mod, sum} files have been changed. on: pull_request: push: branches: - - master + - main jobs: golangci: name: golangci-lint diff --git a/.github/workflows/sims.yml b/.github/workflows/sims.yml index cdbd8b0..6995b94 100644 --- a/.github/workflows/sims.yml +++ b/.github/workflows/sims.yml @@ -5,7 +5,7 @@ on: pull_request: push: branches: - - master + - main - develop jobs: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index fab8bd3..97e7afb 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,11 +1,11 @@ name: Tests / Code Coverage # Tests / Code Coverage workflow runs unit tests and uploads a code coverage report -# This workflow is run on pushes to master & every Pull Requests where a .go, .mod, .sum have been changed +# This workflow is run on pushes to main & every Pull Requests where a .go, .mod, .sum have been changed on: pull_request: push: branches: - - master + - main jobs: cleanup-runs: runs-on: ubuntu-latest @@ -13,7 +13,7 @@ jobs: - uses: rokroskar/workflow-run-cleanup-action@master env: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" - if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/master' && github.ref != 'refs/heads/develop'" + if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/main' && github.ref != 'refs/heads/develop'" build: runs-on: ubuntu-latest diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03784e9..755397b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,13 @@ # Contributing -We welcome contributions from anyone who is willing to create a new PR on budget module, make sure that you read and comply with this document. See the [open issues](https://github.com/tendermint/budget/issues) that we need help with. Feel free to inform us if you are willing to work on any issue. Note that the `master` branch contains the latest development version. +We welcome contributions from anyone who is willing to create a new PR on budget module, make sure that you read and comply with this document. See the [open issues](https://github.com/tendermint/budget/issues) that we need help with. Feel free to inform us if you are willing to work on any issue. Note that the `main` branch contains the latest development version. We follow standard github best practices: - Fork the repository -- Make sure your `branch` is from the tip of `master` branch +- Make sure your `branch` is from the tip of `main` branch - Make some commits to resolve an issue -- Submit a pull request to `master` +- Submit a pull request to `main` Rule of thumb: diff --git a/README.md b/README.md index fbb5dc9..a882ed0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![codecov](https://codecov.io/gh/tendermint/budget/branch/master/graph/badge.svg)](https://codecov.io/gh/tendermint/budget?branch=master) +[![codecov](https://codecov.io/gh/tendermint/budget/branch/main/graph/badge.svg)](https://codecov.io/gh/tendermint/budget?branch=main) [![PkgGoDev](https://pkg.go.dev/badge/github.com/tendermint/budget)](https://pkg.go.dev/github.com/tendermint/budget) # Budget Module @@ -8,7 +8,7 @@ A budget module is a Cosmos SDK module that implements budget functionality. It A primary use case is for Gravity DEX farming plan. The budget module can be used to create a budget plan that defines Cosmos Hub's FeeCollector module account where transaction gas fees and part of ATOM inflation are collected as budget source address and uses a custom module account (created by budget creator) as collection address. Read [spec docs](./x/budget/spec/01_concepts.md) to get to know more about the module. ⚠ **Budget module v1 is in active development** ⚠ -- see the [master](https://github.com/tendermint/budget/tree/master) branch for the latest +- see the [main](https://github.com/tendermint/budget/tree/main) branch for the latest - see [releases](https://github.com/tendermint/budget/releases) for the latest release ## Dependencies @@ -35,15 +35,15 @@ To get started to the project, visit the [TECHNICAL-SETUP.md](./TECHNICAL-SETUP. ## Documentation -The farming module documentation is available in [docs](./docs) folder and technical specification is available in [specs](https://github.com/tendermint/budget/blob/master/x/budget/spec/README.md) folder. +The farming module documentation is available in [docs](./docs) folder and technical specification is available in [specs](https://github.com/tendermint/budget/blob/main/x/budget/spec/README.md) folder. These are some of the documents that help you to quickly get you on board with the budget module. - [How to bootstrap a local network with budget module](./docs/Tutorials/localnet) - [How to use Command Line Interfaces](./docs/How-To/cli) - [How to use gRPC-gateway REST Routes](./docs/How-To) -- [Demo for how to budget and budget modules](https://github.com/tendermint/farming/blob/master/docs/Tutorials/demo/budget_with_farming.md) +- [Demo for how to budget and budget modules](https://github.com/tendermint/farming/blob/main/docs/Tutorials/demo/budget_with_farming.md) ## Contributing -We welcome contributions from everyone. The [master](https://github.com/tendermint/budget/tree/master) branch contains the development version of the code. You can branch of from master and create a pull request, or maintain your own fork and submit a cross-repository pull request. If you're not sure where to start check out [CONTRIBUTING.md](./CONTRIBUTING.md) for our guidelines & policies for how we develop budget module. Thank you to all those who have contributed to budget module! +We welcome contributions from everyone. The [main](https://github.com/tendermint/budget/tree/main) branch contains the development version of the code. You can branch of from main and create a pull request, or maintain your own fork and submit a cross-repository pull request. If you're not sure where to start check out [CONTRIBUTING.md](./CONTRIBUTING.md) for our guidelines & policies for how we develop budget module. Thank you to all those who have contributed to budget module! diff --git a/TECHNICAL-SETUP.md b/TECHNICAL-SETUP.md index b34e604..e27a8b4 100644 --- a/TECHNICAL-SETUP.md +++ b/TECHNICAL-SETUP.md @@ -58,10 +58,10 @@ GOOS=windows GOARCH=amd64 make build To install the node client on your machine, run `make install` command from the project's root folder. -> 💡 you can also use the default `go` command to build the project, check the content of the [Makefile](https://github.com/tendermint/budget/blob/master/Makefile#L87) for reference +> 💡 you can also use the default `go` command to build the project, check the content of the [Makefile](https://github.com/tendermint/budget/blob/main/Makefile#L87) for reference ## Testing Run `make test-all` command to run tests. -> 💡 you can also use the default `go` command to build the project, check the content of the [Makefile](https://github.com/tendermint/budget/blob/master/Makefile#L139) for reference +> 💡 you can also use the default `go` command to build the project, check the content of the [Makefile](https://github.com/tendermint/budget/blob/main/Makefile#L139) for reference diff --git a/docs/Explanation/ADR/PROCESS.md b/docs/Explanation/ADR/PROCESS.md index 0735802..1f758f8 100644 --- a/docs/Explanation/ADR/PROCESS.md +++ b/docs/Explanation/ADR/PROCESS.md @@ -18,7 +18,7 @@ ADR creation is an **iterative** process. Instead of trying to solve all decisio 2. After the motivation is validated, create a new document that is on the `adr-template.md`. -3. An ADR solution doesn't have to arrive to the `master` branch with an _accepted_ status in a single PR. If the motivation is clear and the solution is sound, we SHOULD be able to merge PRs iteratively and keep a _proposed_ status. It's preferable to have an iterative approach rather than long, not merged Pull Requests. +3. An ADR solution doesn't have to arrive to the `main` branch with an _accepted_ status in a single PR. If the motivation is clear and the solution is sound, we SHOULD be able to merge PRs iteratively and keep a _proposed_ status. It's preferable to have an iterative approach rather than long, not merged Pull Requests. 4. If a _proposed_ ADR is merged, then the outstanding changes must be clearly documented in outstanding issues in ADR document notes or in a GitHub Issue. diff --git a/docs/How-To/cli/README.md b/docs/How-To/cli/README.md index b353db5..eb30547 100644 --- a/docs/How-To/cli/README.md +++ b/docs/How-To/cli/README.md @@ -95,7 +95,7 @@ budgetd q bank balances cosmos10pg34xts7pztyu9n63vsydujjayge7gergyzavl4dhpq36hgm ## Query -https://github.com/tendermint/budget/blob/master/proto/tendermint/budget/v1beta1/query.proto +https://github.com/tendermint/budget/blob/main/proto/tendermint/budget/v1beta1/query.proto ### Params diff --git a/docs/Reference/proposals/01_proposal.md b/docs/Reference/proposals/01_proposal.md index 68e56f4..491c392 100644 --- a/docs/Reference/proposals/01_proposal.md +++ b/docs/Reference/proposals/01_proposal.md @@ -82,6 +82,6 @@ We need two kinds of governance processes to activate Gravity DEX liquidity ince Detail description of the spec can be found below: -- Budget Module: https://github.com/tendermint/budget/tree/master/x/budget/spec +- Budget Module: https://github.com/tendermint/budget/tree/main/x/budget/spec -- Farming Module: https://github.com/tendermint/farming/tree/master/x/farming/spec \ No newline at end of file +- Farming Module: https://github.com/tendermint/farming/tree/main/x/farming/spec \ No newline at end of file diff --git a/docs/Tutorials/demo/README.md b/docs/Tutorials/demo/README.md index 8bc4e2f..ec7f2da 100644 --- a/docs/Tutorials/demo/README.md +++ b/docs/Tutorials/demo/README.md @@ -1,4 +1,4 @@ # Demo -- [Budget & Farming MVP demo](https://github.com/tendermint/farming/blob/master/docs/Tutorials/demo/budget_with_farming.md) \ No newline at end of file +- [Budget & Farming MVP demo](https://github.com/tendermint/farming/blob/main/docs/Tutorials/demo/budget_with_farming.md) \ No newline at end of file diff --git a/x/budget/spec/02_state.md b/x/budget/spec/02_state.md index 0a8d01f..0c9d724 100644 --- a/x/budget/spec/02_state.md +++ b/x/budget/spec/02_state.md @@ -16,7 +16,7 @@ type Budget struct { } ``` -+++ https://github.com/tendermint/budget/blob/master/proto/tendermint/budget/v1beta1/budget.proto#L25-L53 ++++ https://github.com/tendermint/budget/blob/main/proto/tendermint/budget/v1beta1/budget.proto#L25-L53 ## TotalCollectedCoins @@ -27,7 +27,7 @@ type TotalCollectedCoins struct { } ``` -+++ https://github.com/tendermint/budget/blob/master/proto/tendermint/budget/v1beta1/budget.proto#L55-L64 ++++ https://github.com/tendermint/budget/blob/main/proto/tendermint/budget/v1beta1/budget.proto#L55-L64 For the purpose of tracking total collected coins for a budget, budget name is used as key to find it in store. diff --git a/x/budget/spec/04_begin_block.md b/x/budget/spec/04_begin_block.md index d6ed4b4..75da26e 100644 --- a/x/budget/spec/04_begin_block.md +++ b/x/budget/spec/04_begin_block.md @@ -4,7 +4,7 @@ At each `BeginBlock`, get all budgets registered in `params.Budgets` and select the valid budgets to collect budgets for the block by its respective plan (defined rate, budget source address, collection address, start time and end time). Then, it distributes the collected amount of coins from `BudgetSourceAddrss` to `CollectionAddress`. -+++ https://github.com/tendermint/budget/blob/master/x/budget/abci.go#L15-L22 ++++ https://github.com/tendermint/budget/blob/main/x/budget/abci.go#L15-L22 ## Workflow diff --git a/x/budget/spec/06_params.md b/x/budget/spec/06_params.md index 6341f8a..c4f32e0 100644 --- a/x/budget/spec/06_params.md +++ b/x/budget/spec/06_params.md @@ -21,7 +21,7 @@ The default value is 1 and all budget collections are disabled if the value is 0 params.EpochBlocks > 0 && Current Block Height % params.EpochBlocks == 0 ``` -You can reference [the line of the code](https://github.com/tendermint/budget/blob/master/x/budget/keeper/budget.go#L78). +You can reference [the line of the code](https://github.com/tendermint/budget/blob/main/x/budget/keeper/budget.go#L78). ## Budgets @@ -43,4 +43,4 @@ An example of how to add a budget plan can be found in this [docs/How-To/cli](.. - The total rate of budgets with the same `BudgetSourceAddress` value should not exceed 1 (100%). -+++ https://github.com/tendermint/budget/blob/master/x/budget/types/budget.go#L33-L63 \ No newline at end of file ++++ https://github.com/tendermint/budget/blob/main/x/budget/types/budget.go#L33-L63 \ No newline at end of file