From de7924020dfa7596ccc74362dbac4e1d3a49cb24 Mon Sep 17 00:00:00 2001 From: Freddy Li Date: Mon, 1 Feb 2021 13:46:00 -0500 Subject: [PATCH 01/11] update contributor guidlines --- CONTRIBUTING.md | 272 ++++++++++++++++++++++++++++++++++-------------- 1 file changed, 194 insertions(+), 78 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 59bdeefab..7d53eb7f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,106 +1,222 @@ -# Contributing +# Ethermint Contributor Guidelines + +*** +Thank you for considering making contributions to Ethermint and related repositories! + +Ethermint uses [Tendermint’s coding repo](https://github.com/tendermint/coding) for overall information on repository +workflow and standards. + +Contributing to this repo can mean many things such as participating in discussion or proposing code changes. To ensure +a smooth workflow for all contributors, the general procedure for contributing has been established. + +## General Procedure + +*** + +1. Either [open](https://github.com/cosmos/cosmos-sdk/issues/new/choose) + or [find](https://github.com/cosmos/cosmos-sdk/issues) an issue you have identified and would like to contribute to + resolving. +2. Participate in thoughtful discussion on that issue. +3. If you would like to contribute: + 1. If the issue is a proposal, ensure that the proposal has been accepted by ChainSafe’s Ethermint team. + 2. Ensure that nobody else has already begun working on the same issue. If someone already has, please make sure to + contact the individual to collaborate. + 3. If nobody has been assigned the issue and you would like to work on it, make a comment on the issue to inform the + community of your intentions to begin work. Ideally, wait for confirmation that no one has started it. However, + if you are eager and do not get a prompt response, feel free to dive on in! + 4. Follow standard Github best practices: + 1. fork the repo + 2. branch from the HEAD of `development`(For core developers working within the cosmos-sdk repo, to ensure a + clear ownership of branches, branches must be named with the convention `{moniker}/{issue#}-branch-name`.) + 3. make commits + 4. submit a PR to `development` + 5. Be sure to submit the PR in `Draft` mode. Submit your PR early, even if it's incomplete as this indicates to the + community you're working on something and allows them to provide comments early in the development process. + 6. When the code is complete it can be marked `Ready for Review`. + 7. Be sure to include a relevant change log entry in the `Unreleased` section of `CHANGELOG.md` (see file for log + format). + 8. Please make sure to run `make format` before every commit - the easiest way to do this is having your editor run + it for you upon saving a file. Additionally please ensure that your code is lint compliant by running `make lint` + . There are CI tests built into the Ethermint repository and all PR’s will require that these tests pass before + they are able to be merged. + +**Note**: for very small or blatantly obvious problems (such as typos) it is not required to open an issue to submit a +PR, but be aware that for more complex problems/features, if a PR is opened before an adequate design discussion has +taken place in a github issue, that PR runs a high likelihood of being rejected. + +Looking for a good place to start contributing? How about checking out +some [good first issues](https://github.com/cosmos/ethermint/issues?q=label%3A%22good+first+issue%22). + +## Architecture Decision Records (ADR) + +*** +When proposing an architecture decision for the SDK, please create +an [ADR](https://github.com/cosmos/ethermint/blob/development/docs/architecture/README.md) so further discussions can be +made. We are following this process so all involved parties are in agreement before any party begins coding the proposed +implementation. If you would like to see some examples of how these are written refer +to [Tendermint ADRs](https://github.com/tendermint/tendermint/tree/master/docs/architecture). + +## Pull Requests + +*** +To accommodate the review process we suggest that PRs are categorically broken up. Ideally each PR addresses only a +single issue. Additionally, as much as possible code refactoring and cleanup should be submitted as separate PRs from +bug fixes/feature-additions. + +## Process for reviewing PRs + +*** +All PRs require two Reviews before merge. When reviewing PRs please use the following review explanations: + +1. `LGTM` without an explicit approval means that the changes look good, but you haven't pulled down the code, run tests + locally and thoroughly reviewed it. +2. `Approval` through the GH UI means that you understand the code, documentation/spec is updated in the right places, + you have pulled down and tested the code locally. In addition: + * You must think through whether any added code could be partially combined (DRYed) with existing code. + * You must think through any potential security issues or incentive-compatibility flaws introduced by the changes. + * Naming convention must be consistent with the rest of the codebase. + * Code must live in a reasonable location, considering dependency structures (e.g. not importing testing modules in + production code, or including example code modules in production code). + * If you approve of the PR, you are responsible for fixing any of the issues mentioned here. +3. If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review. + +## Updating Documentation + +*** +If you open a PR on the Ethermint repo, it is mandatory to update the relevant documentation in `/docs`. Please refer to +the docs subdirectory and make changes accordingly. Prior to approval, the Code owners/approvers may request some +updates to specific docs. -Thank you for considering making contributions to Ethermint! Start by taking a look at this [coding repo](https://github.com/tendermint/coding) for overall information on repository workflow and standards. +## Forking -Please follow standard github best practices: fork the repo, branch from the tip of develop, make some commits, and submit a pull request to develop. See the [open issues](https://github.com/cosmos/ethermint/issues) for things we need help with! +*** +Please note that Go requires code to live under absolute paths, which complicates forking. While my fork lives +at `https://github.com/chainsafe/cosmos-sdk`, the code should never exist +at `$GOPATH/src/github.com/chainsafe/cosmos-sdk`. Instead, we use `git remote` to add the fork as a new remote for the +original repo,`$GOPATH/src/github.com/cosmos/cosmos-sdk`, and do all the work there. -Please make sure to use `gofmt` before every commit - the easiest way to do this is have your editor run it for you upon saving a file. Additionally please ensure that your code is lint compliant by running `make lint` +For instance, to create a fork and work on a branch of it, you would: -Looking for a good place to start contributing? How about checking out some [good first issues](https://github.com/cosmos/ethermint/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) +1. Create the fork on github, using the fork button. +2. Go to the original repo checked out locally. (i.e. `$GOPATH/src/github.com/cosmos/cosmos-sdk`) +3. `git remote rename origin upstream` +4. `git remote add origin git@github.com:chainsafe/cosmos-sdk.git` -## Forking +Now `origin` refers to my fork and `upstream` refers to the Cosmos-SDK version. So I can `git push -u origin master` to +update my fork, and make pull requests to Cosmos-SDK from there. Of course, replace `chainsafe` with your git handle. + +To pull in updates from the origin repo, run: -Please note that Go requires code to live under absolute paths, which complicates forking. -While your fork should live at `https://github.com//ethermint`, -the code should not exist at `$GOPATH/src/github.com//ethermint`. -Instead, you should use `git remote` to add the fork as a new remote for the original repo, -`$GOPATH/src/github.com/cosmos/ethermint `, and do all the work there. +1. `git fetch upstream` +2. `git rebase upstream/master` (or whatever branch you want) -For instance, to create a fork and work on a branch of it, One would: +Please **NO DOT** make Pull Requests from `development`. - * Create the fork on github, using the fork button. - * Go to the original repo checked out locally (i.e. `$GOPATH/src/github.com/cosmos/ethermint`) - * `git remote rename origin upstream` - * `git remote add origin git@github.com:/ethermint.git` +## Dependencies -Now `origin` refers to my fork and `upstream` refers to the Ethermint version. -So I can `git push -u origin ` to update my fork, and make pull requests to Ethermint from there. -Of course, replace `` with your git handle. +*** +We use [Go 1.15](https://github.com/golang/go/wiki/Modules) Modules to manage dependency versions. The master branch of +every Cosmos repository should just build with `go get`, which means they should be kept up-to-date with their +dependencies, so we can get away with telling people they can just `go get` our software. -To pull in updates from the origin repo, run +Since some dependencies are not under our control, a third party may break our build, in which case we can fall back +on `go mod tidy -v`. - * `git fetch upstream` - * `git rebase upstream/develop` (or whatever branch you want) +## Protobuf -Do not make Pull Requests to `master`, they will not be considered. +*** +We use [Protocol Buffers](https://developers.google.com/protocol-buffers) along +with [gogoproto](https://github.com/gogo/protobuf) to generate code for use in Cosmos-SDK. -## Dependencies +For deterministic behavior around Protobuf tooling, everything is containerized using Docker. Make sure to have Docker +installed on your machine, or head to [Docker's website](https://docs.docker.com/get-docker/) to install it. -We use [`dep`](https://github.com/golang/dep) to manage dependencies. +For formatting code in `.proto` files, you can run `make proto-format` command. -That said, the master branch of every Cosmos repository should just build -with `go get`, which means they should be kept up-to-date with their -dependencies so we can get away with telling people they can just `go get` our -software. +For linting and checking breaking changes, we use [buf](https://buf.build/). You can use the commands `make proto-lint` +and `make proto-check-breaking` to respectively lint your proto files and check for breaking changes. -Since some dependencies are not under our control, a third party may break our -build, in which case we can fall back on `dep ensure` (or `make -deps`). Even for dependencies under our control, `dep` helps us to -keep multiple repos in sync as they evolve. Anything with an executable, such -as apps, tools, and the core, should use `dep`. +To generate the protobuf stubs, you can run `make proto-gen`. -Run `dep status` to get a list of vendor dependencies that may not be -up-to-date. +We also added the `make proto-all` command to run all the above commands sequentially. -## Testing +In order for imports to properly compile in your IDE, you may need to manually set your protobuf path in your IDE's +workspace `settings/config`. -All repos should be hooked up to [CircleCI](https://circleci.com/). +For example, in vscode your `.vscode/settings.json` should look like: -If they have `.go` files in the root directory, they will be automatically -tested by circle using `go test -v -race ./...`. If not, they will need a -`circle.yml`. Ideally, every repo has a `Makefile` that defines `make test` and -includes its continuous integration status using a badge in the `README.md`. +```json +{ + "protoc": { + "options": [ + "--proto_path=${workspaceRoot}/proto", + "--proto_path=${workspaceRoot}/third_party/proto" + ] + } +} +``` + +## Testing + +*** +Ethermint uses [GitHub Actions](https://github.com/features/actions) for automated testing. ## Branching Model and Release -User-facing repos should adhere to the branching model: http://nvie.com/posts/a-successful-git-branching-model/. -That is, these repos should be well versioned, and any merge to master requires a version bump and tagged release. +*** +User-facing repos should adhere to the trunk based development branching +model: [https://trunkbaseddevelopment.com/](https://trunkbaseddevelopment.com/). Libraries need not follow the model strictly, but would be wise to. Ethermint utilizes [semantic versioning](https://semver.org/). -### Development Procedure: -- the latest state of development is on `develop` -- `develop` must never fail `make test` -- `develop` should not fail `make lint` -- no --force onto `develop` (except when reverting a broken commit, which should seldom happen) -- create a development branch either on github.com/cosmos/ethermint, or your fork (using `git remote add origin`) -- [squash your commits](https://github.com/todotxt/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit) into an individual commit -- before submitting a pull request, begin `git rebase` on top of `develop` - -### Pull Merge Procedure: -- ensure pull branch is rebased on develop -- [squash your commits](https://github.com/todotxt/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit) into an individual commit -- run `make test` and `make test-cli` to ensure that all tests pass -- merge pull request - -### Release Procedure: -- start on `develop` -- prepare changelog/release issue -- bump versions -- push to release-vX.X.X to run CI -- merge to master -- merge master back to develop - -### Hotfix Procedure: -- start on `master` -- checkout a new branch named hotfix-vX.X.X -- make the required changes - - these changes should be small and an absolute necessity - - add a note to CHANGELOG.md -- bump versions -- push to hotfix-vX.X.X to run the extended integration tests on the CI -- merge hotfix-vX.X.X to master -- merge hotfix-vX.X.X to develop -- delete the hotfix-vX.X.X branch +## PR Targeting + +*** +Ensure that you base and target your PR on the `development` branch. + +All feature additions should be targeted against `development`. Bug fixes for an outstanding release candidate should be +targeted against the release candidate branch. + +## Development Procedure + +*** + +1. The latest state of development is on `development`. +2. `development` must never + fail `make lint, make test, make test-race, make test-rpc, make test-solidity, make test-import` +3. No `--force` onto `development` (except when reverting a broken commit, which should seldom happen). +4. Create your feature branch from `development` either on `github.com/cosmos/ethermint`, or your fork ( + using `git remote add origin`). +5. Before submitting a pull request, begin `git rebase` on top of `development`. + +## Pull Merge Procedure + +*** + +* Ensure pull branch is rebased on `development`. +* Run `make test` to ensure that all tests pass. +* Squash merge pull request. + +## Release Procedure + +*** + +* Start on `development`. +* Create the release candidate branch `rc/v*` (going forward known as RC) and ensure it's protected against pushing from + anyone except the release manager/coordinator. No PRs targeting this branch should be merged unless exceptional + circumstances arise. +* On the `RC` branch, prepare a new version section in the `CHANGELOG.md`. All links must be + link-ified: `$ python ./scripts/linkify_changelog.py CHANGELOG.md`. Copy the entries into a `RELEASE_CHANGELOG.md`, + this is needed so the bot knows which entries to add to the release page on github. +* Kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks). +* If errors are found during the simulation testing, commit the fixes to development and create a new `RC` branch ( + making sure to increment the `rcN`). +* After simulation has successfully completed, create the release branch (`release/vX.XX.X`) from the `RC` branch. +* Create a PR to `development` to incorporate the `CHANGELOG.md` updates. +* Tag the release (use `git tag -a`) and create a release in Github. +* Delete the `RC` branches. + +**Note**: ChainSafe’s Ethermint team currently cuts releases on a need to have basis. We will announce a more +standardized release schedule as we near production readiness. \ No newline at end of file From 419e964c7b132e75fd0bc69a76f43bc57312af65 Mon Sep 17 00:00:00 2001 From: Freddy Li Date: Mon, 1 Feb 2021 13:59:52 -0500 Subject: [PATCH 02/11] add table --- CONTRIBUTING.md | 49 ++++++++++++++++++++++++++++++++----------------- 1 file changed, 32 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7d53eb7f3..b7a19b910 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,24 @@ # Ethermint Contributor Guidelines +*** + +* [General Procedure](#general_procedure) +* [Architecture Decision Records (ADR)](#adr) +* [Pull Requests](#pull_requests) +* [Process for reviewing PRs](#reviewing_prs) +* [Updating Documentation](#updating_doc) +* [Forking](#forking) +* [Dependencies](#dependencies) +* [Protobuf](#protobuf) +* [Testing](#testing) +* [Branching Model and Release](#braching_model_and_release) +* [PR Targeting](#pr_targeting) +* [Development Procedure](#dev_procedure) +* [Pull Merge Procedure](#pull_merge_procedure) +* [Release Procedure](#release_procedure) + +## General Procedure + *** Thank you for considering making contributions to Ethermint and related repositories! @@ -9,10 +28,6 @@ workflow and standards. Contributing to this repo can mean many things such as participating in discussion or proposing code changes. To ensure a smooth workflow for all contributors, the general procedure for contributing has been established. -## General Procedure - -*** - 1. Either [open](https://github.com/cosmos/cosmos-sdk/issues/new/choose) or [find](https://github.com/cosmos/cosmos-sdk/issues) an issue you have identified and would like to contribute to resolving. @@ -47,7 +62,7 @@ taken place in a github issue, that PR runs a high likelihood of being rejected. Looking for a good place to start contributing? How about checking out some [good first issues](https://github.com/cosmos/ethermint/issues?q=label%3A%22good+first+issue%22). -## Architecture Decision Records (ADR) +## Architecture Decision Records (ADR) *** When proposing an architecture decision for the SDK, please create @@ -56,14 +71,14 @@ made. We are following this process so all involved parties are in agreement bef implementation. If you would like to see some examples of how these are written refer to [Tendermint ADRs](https://github.com/tendermint/tendermint/tree/master/docs/architecture). -## Pull Requests +## Pull Requests *** To accommodate the review process we suggest that PRs are categorically broken up. Ideally each PR addresses only a single issue. Additionally, as much as possible code refactoring and cleanup should be submitted as separate PRs from bug fixes/feature-additions. -## Process for reviewing PRs +## Process for reviewing PRs *** All PRs require two Reviews before merge. When reviewing PRs please use the following review explanations: @@ -80,14 +95,14 @@ All PRs require two Reviews before merge. When reviewing PRs please use the foll * If you approve of the PR, you are responsible for fixing any of the issues mentioned here. 3. If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review. -## Updating Documentation +## Updating Documentation *** If you open a PR on the Ethermint repo, it is mandatory to update the relevant documentation in `/docs`. Please refer to the docs subdirectory and make changes accordingly. Prior to approval, the Code owners/approvers may request some updates to specific docs. -## Forking +## Forking *** Please note that Go requires code to live under absolute paths, which complicates forking. While my fork lives @@ -112,7 +127,7 @@ To pull in updates from the origin repo, run: Please **NO DOT** make Pull Requests from `development`. -## Dependencies +## Dependencies *** We use [Go 1.15](https://github.com/golang/go/wiki/Modules) Modules to manage dependency versions. The master branch of @@ -122,7 +137,7 @@ dependencies, so we can get away with telling people they can just `go get` our Since some dependencies are not under our control, a third party may break our build, in which case we can fall back on `go mod tidy -v`. -## Protobuf +## Protobuf *** We use [Protocol Buffers](https://developers.google.com/protocol-buffers) along @@ -156,12 +171,12 @@ For example, in vscode your `.vscode/settings.json` should look like: } ``` -## Testing +## Testing *** Ethermint uses [GitHub Actions](https://github.com/features/actions) for automated testing. -## Branching Model and Release +## Branching Model and Release *** User-facing repos should adhere to the trunk based development branching @@ -171,7 +186,7 @@ Libraries need not follow the model strictly, but would be wise to. Ethermint utilizes [semantic versioning](https://semver.org/). -## PR Targeting +## PR Targeting *** Ensure that you base and target your PR on the `development` branch. @@ -179,7 +194,7 @@ Ensure that you base and target your PR on the `development` branch. All feature additions should be targeted against `development`. Bug fixes for an outstanding release candidate should be targeted against the release candidate branch. -## Development Procedure +## Development Procedure *** @@ -191,7 +206,7 @@ targeted against the release candidate branch. using `git remote add origin`). 5. Before submitting a pull request, begin `git rebase` on top of `development`. -## Pull Merge Procedure +## Pull Merge Procedure *** @@ -199,7 +214,7 @@ targeted against the release candidate branch. * Run `make test` to ensure that all tests pass. * Squash merge pull request. -## Release Procedure +## Release Procedure *** From 677834b846c016d52127c5b55475db63da2f3e21 Mon Sep 17 00:00:00 2001 From: Freddy Li Date: Mon, 1 Feb 2021 14:15:40 -0500 Subject: [PATCH 03/11] minor changes --- CONTRIBUTING.md | 55 ++++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 28 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7a19b910..b55636ead 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Ethermint Contributor Guidelines -*** +*--- * [General Procedure](#general_procedure) * [Architecture Decision Records (ADR)](#adr) @@ -19,7 +19,7 @@ ## General Procedure -*** +--- Thank you for considering making contributions to Ethermint and related repositories! Ethermint uses [Tendermint’s coding repo](https://github.com/tendermint/coding) for overall information on repository @@ -42,7 +42,7 @@ a smooth workflow for all contributors, the general procedure for contributing h 4. Follow standard Github best practices: 1. fork the repo 2. branch from the HEAD of `development`(For core developers working within the cosmos-sdk repo, to ensure a - clear ownership of branches, branches must be named with the convention `{moniker}/{issue#}-branch-name`.) + clear ownership of branches, branches must be named with the convention `{moniker}/{issue#}-branch-name`). 3. make commits 4. submit a PR to `development` 5. Be sure to submit the PR in `Draft` mode. Submit your PR early, even if it's incomplete as this indicates to the @@ -55,7 +55,7 @@ a smooth workflow for all contributors, the general procedure for contributing h . There are CI tests built into the Ethermint repository and all PR’s will require that these tests pass before they are able to be merged. -**Note**: for very small or blatantly obvious problems (such as typos) it is not required to open an issue to submit a +**Note**: for very small or blatantly obvious problems (such as typos), it is not required to open an issue to submit a PR, but be aware that for more complex problems/features, if a PR is opened before an adequate design discussion has taken place in a github issue, that PR runs a high likelihood of being rejected. @@ -64,7 +64,7 @@ some [good first issues](https://github.com/cosmos/ethermint/issues?q=label%3A%2 ## Architecture Decision Records (ADR) -*** +--- When proposing an architecture decision for the SDK, please create an [ADR](https://github.com/cosmos/ethermint/blob/development/docs/architecture/README.md) so further discussions can be made. We are following this process so all involved parties are in agreement before any party begins coding the proposed @@ -73,15 +73,15 @@ to [Tendermint ADRs](https://github.com/tendermint/tendermint/tree/master/docs/a ## Pull Requests -*** -To accommodate the review process we suggest that PRs are categorically broken up. Ideally each PR addresses only a +--- +To accommodate the review process, we suggest that PRs are categorically broken up. Ideally each PR addresses only a single issue. Additionally, as much as possible code refactoring and cleanup should be submitted as separate PRs from bug fixes/feature-additions. ## Process for reviewing PRs -*** -All PRs require two Reviews before merge. When reviewing PRs please use the following review explanations: +--- +All PRs require two Reviews before merge. When reviewing PRs, please use the following review explanations: 1. `LGTM` without an explicit approval means that the changes look good, but you haven't pulled down the code, run tests locally and thoroughly reviewed it. @@ -97,14 +97,14 @@ All PRs require two Reviews before merge. When reviewing PRs please use the foll ## Updating Documentation -*** +--- If you open a PR on the Ethermint repo, it is mandatory to update the relevant documentation in `/docs`. Please refer to the docs subdirectory and make changes accordingly. Prior to approval, the Code owners/approvers may request some updates to specific docs. ## Forking -*** +--- Please note that Go requires code to live under absolute paths, which complicates forking. While my fork lives at `https://github.com/chainsafe/cosmos-sdk`, the code should never exist at `$GOPATH/src/github.com/chainsafe/cosmos-sdk`. Instead, we use `git remote` to add the fork as a new remote for the @@ -129,7 +129,7 @@ Please **NO DOT** make Pull Requests from `development`. ## Dependencies -*** +--- We use [Go 1.15](https://github.com/golang/go/wiki/Modules) Modules to manage dependency versions. The master branch of every Cosmos repository should just build with `go get`, which means they should be kept up-to-date with their dependencies, so we can get away with telling people they can just `go get` our software. @@ -139,7 +139,7 @@ on `go mod tidy -v`. ## Protobuf -*** +--- We use [Protocol Buffers](https://developers.google.com/protocol-buffers) along with [gogoproto](https://github.com/gogo/protobuf) to generate code for use in Cosmos-SDK. @@ -173,14 +173,13 @@ For example, in vscode your `.vscode/settings.json` should look like: ## Testing -*** +--- Ethermint uses [GitHub Actions](https://github.com/features/actions) for automated testing. ## Branching Model and Release -*** -User-facing repos should adhere to the trunk based development branching -model: [https://trunkbaseddevelopment.com/](https://trunkbaseddevelopment.com/). +--- +User-facing repos should adhere to the [trunk based development branching model](https://trunkbaseddevelopment.com/). Libraries need not follow the model strictly, but would be wise to. @@ -188,7 +187,7 @@ Ethermint utilizes [semantic versioning](https://semver.org/). ## PR Targeting -*** +--- Ensure that you base and target your PR on the `development` branch. All feature additions should be targeted against `development`. Bug fixes for an outstanding release candidate should be @@ -196,19 +195,18 @@ targeted against the release candidate branch. ## Development Procedure -*** +--- 1. The latest state of development is on `development`. 2. `development` must never fail `make lint, make test, make test-race, make test-rpc, make test-solidity, make test-import` 3. No `--force` onto `development` (except when reverting a broken commit, which should seldom happen). -4. Create your feature branch from `development` either on `github.com/cosmos/ethermint`, or your fork ( - using `git remote add origin`). +4. Create your feature branch from `development` either on `github.com/cosmos/ethermint`, or your fork (using `git remote add origin`). 5. Before submitting a pull request, begin `git rebase` on top of `development`. ## Pull Merge Procedure -*** +--- * Ensure pull branch is rebased on `development`. * Run `make test` to ensure that all tests pass. @@ -216,18 +214,19 @@ targeted against the release candidate branch. ## Release Procedure -*** +--- * Start on `development`. -* Create the release candidate branch `rc/v*` (going forward known as RC) and ensure it's protected against pushing from +* Create the release candidate branch `rc/v*` (going forward known as `RC`) and ensure it's protected against pushing from anyone except the release manager/coordinator. No PRs targeting this branch should be merged unless exceptional circumstances arise. * On the `RC` branch, prepare a new version section in the `CHANGELOG.md`. All links must be - link-ified: `$ python ./scripts/linkify_changelog.py CHANGELOG.md`. Copy the entries into a `RELEASE_CHANGELOG.md`, - this is needed so the bot knows which entries to add to the release page on github. + link-ified: + `$ python ./scripts/linkify_changelog.py CHANGELOG.md`. + Copy the entries into a `RELEASE_CHANGELOG.md`. + This is needed so the bot knows which entries to add to the release page on github. * Kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks). -* If errors are found during the simulation testing, commit the fixes to development and create a new `RC` branch ( - making sure to increment the `rcN`). +* If errors are found during the simulation testing, commit the fixes to `development` and create a new `RC` branch (making sure to increment the `rcN`). * After simulation has successfully completed, create the release branch (`release/vX.XX.X`) from the `RC` branch. * Create a PR to `development` to incorporate the `CHANGELOG.md` updates. * Tag the release (use `git tag -a`) and create a release in Github. From 72efe6330230233eaf60c4b82fdf9d5dc15afdc9 Mon Sep 17 00:00:00 2001 From: Freddy Li Date: Mon, 1 Feb 2021 14:19:08 -0500 Subject: [PATCH 04/11] remove horizontal rules --- CONTRIBUTING.md | 36 +++++++++--------------------------- 1 file changed, 9 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b55636ead..432fa6bac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,5 @@ # Ethermint Contributor Guidelines -*--- - * [General Procedure](#general_procedure) * [Architecture Decision Records (ADR)](#adr) * [Pull Requests](#pull_requests) @@ -19,7 +17,6 @@ ## General Procedure ---- Thank you for considering making contributions to Ethermint and related repositories! Ethermint uses [Tendermint’s coding repo](https://github.com/tendermint/coding) for overall information on repository @@ -64,7 +61,6 @@ some [good first issues](https://github.com/cosmos/ethermint/issues?q=label%3A%2 ## Architecture Decision Records (ADR) ---- When proposing an architecture decision for the SDK, please create an [ADR](https://github.com/cosmos/ethermint/blob/development/docs/architecture/README.md) so further discussions can be made. We are following this process so all involved parties are in agreement before any party begins coding the proposed @@ -73,14 +69,12 @@ to [Tendermint ADRs](https://github.com/tendermint/tendermint/tree/master/docs/a ## Pull Requests ---- To accommodate the review process, we suggest that PRs are categorically broken up. Ideally each PR addresses only a single issue. Additionally, as much as possible code refactoring and cleanup should be submitted as separate PRs from bug fixes/feature-additions. ## Process for reviewing PRs ---- All PRs require two Reviews before merge. When reviewing PRs, please use the following review explanations: 1. `LGTM` without an explicit approval means that the changes look good, but you haven't pulled down the code, run tests @@ -97,14 +91,12 @@ All PRs require two Reviews before merge. When reviewing PRs, please use the fol ## Updating Documentation ---- If you open a PR on the Ethermint repo, it is mandatory to update the relevant documentation in `/docs`. Please refer to the docs subdirectory and make changes accordingly. Prior to approval, the Code owners/approvers may request some updates to specific docs. ## Forking ---- Please note that Go requires code to live under absolute paths, which complicates forking. While my fork lives at `https://github.com/chainsafe/cosmos-sdk`, the code should never exist at `$GOPATH/src/github.com/chainsafe/cosmos-sdk`. Instead, we use `git remote` to add the fork as a new remote for the @@ -129,7 +121,6 @@ Please **NO DOT** make Pull Requests from `development`. ## Dependencies ---- We use [Go 1.15](https://github.com/golang/go/wiki/Modules) Modules to manage dependency versions. The master branch of every Cosmos repository should just build with `go get`, which means they should be kept up-to-date with their dependencies, so we can get away with telling people they can just `go get` our software. @@ -139,7 +130,6 @@ on `go mod tidy -v`. ## Protobuf ---- We use [Protocol Buffers](https://developers.google.com/protocol-buffers) along with [gogoproto](https://github.com/gogo/protobuf) to generate code for use in Cosmos-SDK. @@ -173,12 +163,10 @@ For example, in vscode your `.vscode/settings.json` should look like: ## Testing ---- Ethermint uses [GitHub Actions](https://github.com/features/actions) for automated testing. ## Branching Model and Release ---- User-facing repos should adhere to the [trunk based development branching model](https://trunkbaseddevelopment.com/). Libraries need not follow the model strictly, but would be wise to. @@ -187,7 +175,6 @@ Ethermint utilizes [semantic versioning](https://semver.org/). ## PR Targeting ---- Ensure that you base and target your PR on the `development` branch. All feature additions should be targeted against `development`. Bug fixes for an outstanding release candidate should be @@ -195,38 +182,33 @@ targeted against the release candidate branch. ## Development Procedure ---- - 1. The latest state of development is on `development`. 2. `development` must never fail `make lint, make test, make test-race, make test-rpc, make test-solidity, make test-import` 3. No `--force` onto `development` (except when reverting a broken commit, which should seldom happen). -4. Create your feature branch from `development` either on `github.com/cosmos/ethermint`, or your fork (using `git remote add origin`). +4. Create your feature branch from `development` either on `github.com/cosmos/ethermint`, or your fork ( + using `git remote add origin`). 5. Before submitting a pull request, begin `git rebase` on top of `development`. ## Pull Merge Procedure ---- - * Ensure pull branch is rebased on `development`. * Run `make test` to ensure that all tests pass. * Squash merge pull request. ## Release Procedure ---- - * Start on `development`. -* Create the release candidate branch `rc/v*` (going forward known as `RC`) and ensure it's protected against pushing from - anyone except the release manager/coordinator. No PRs targeting this branch should be merged unless exceptional +* Create the release candidate branch `rc/v*` (going forward known as `RC`) and ensure it's protected against pushing + from anyone except the release manager/coordinator. No PRs targeting this branch should be merged unless exceptional circumstances arise. -* On the `RC` branch, prepare a new version section in the `CHANGELOG.md`. All links must be - link-ified: +* On the `RC` branch, prepare a new version section in the `CHANGELOG.md`. All links must be link-ified: `$ python ./scripts/linkify_changelog.py CHANGELOG.md`. - Copy the entries into a `RELEASE_CHANGELOG.md`. - This is needed so the bot knows which entries to add to the release page on github. + Copy the entries into a `RELEASE_CHANGELOG.md`. This is needed so the bot knows which entries to add to the release + page on github. * Kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks). -* If errors are found during the simulation testing, commit the fixes to `development` and create a new `RC` branch (making sure to increment the `rcN`). +* If errors are found during the simulation testing, commit the fixes to `development` and create a new `RC` branch ( + making sure to increment the `rcN`). * After simulation has successfully completed, create the release branch (`release/vX.XX.X`) from the `RC` branch. * Create a PR to `development` to incorporate the `CHANGELOG.md` updates. * Tag the release (use `git tag -a`) and create a release in Github. From 9fef9bf4bd00fad628d33ac149a9e36719379029 Mon Sep 17 00:00:00 2001 From: Freddy Li Date: Mon, 1 Feb 2021 14:35:25 -0500 Subject: [PATCH 05/11] change order --- CONTRIBUTING.md | 92 ++++++++++++++++++++++++------------------------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 432fa6bac..3aa2aaec9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,18 +2,18 @@ * [General Procedure](#general_procedure) * [Architecture Decision Records (ADR)](#adr) -* [Pull Requests](#pull_requests) -* [Process for reviewing PRs](#reviewing_prs) -* [Updating Documentation](#updating_doc) * [Forking](#forking) * [Dependencies](#dependencies) * [Protobuf](#protobuf) +* [Development Procedure](#dev_procedure) * [Testing](#testing) +* [Updating Documentation](#updating_doc) * [Branching Model and Release](#braching_model_and_release) -* [PR Targeting](#pr_targeting) -* [Development Procedure](#dev_procedure) -* [Pull Merge Procedure](#pull_merge_procedure) -* [Release Procedure](#release_procedure) + * [PR Targeting](#pr_targeting) + * [Pull Requests](#pull_requests) + * [Process for reviewing PRs](#reviewing_prs) + * [Pull Merge Procedure](#pull_merge_procedure) + * [Release Procedure](#release_procedure) ## General Procedure @@ -67,34 +67,6 @@ made. We are following this process so all involved parties are in agreement bef implementation. If you would like to see some examples of how these are written refer to [Tendermint ADRs](https://github.com/tendermint/tendermint/tree/master/docs/architecture). -## Pull Requests - -To accommodate the review process, we suggest that PRs are categorically broken up. Ideally each PR addresses only a -single issue. Additionally, as much as possible code refactoring and cleanup should be submitted as separate PRs from -bug fixes/feature-additions. - -## Process for reviewing PRs - -All PRs require two Reviews before merge. When reviewing PRs, please use the following review explanations: - -1. `LGTM` without an explicit approval means that the changes look good, but you haven't pulled down the code, run tests - locally and thoroughly reviewed it. -2. `Approval` through the GH UI means that you understand the code, documentation/spec is updated in the right places, - you have pulled down and tested the code locally. In addition: - * You must think through whether any added code could be partially combined (DRYed) with existing code. - * You must think through any potential security issues or incentive-compatibility flaws introduced by the changes. - * Naming convention must be consistent with the rest of the codebase. - * Code must live in a reasonable location, considering dependency structures (e.g. not importing testing modules in - production code, or including example code modules in production code). - * If you approve of the PR, you are responsible for fixing any of the issues mentioned here. -3. If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review. - -## Updating Documentation - -If you open a PR on the Ethermint repo, it is mandatory to update the relevant documentation in `/docs`. Please refer to -the docs subdirectory and make changes accordingly. Prior to approval, the Code owners/approvers may request some -updates to specific docs. - ## Forking Please note that Go requires code to live under absolute paths, which complicates forking. While my fork lives @@ -161,10 +133,26 @@ For example, in vscode your `.vscode/settings.json` should look like: } ``` +## Development Procedure + +1. The latest state of development is on `development`. +2. `development` must never + fail `make lint, make test, make test-race, make test-rpc, make test-solidity, make test-import` +3. No `--force` onto `development` (except when reverting a broken commit, which should seldom happen). +4. Create your feature branch from `development` either on `github.com/cosmos/ethermint`, or your fork ( + using `git remote add origin`). +5. Before submitting a pull request, begin `git rebase` on top of `development`. + ## Testing Ethermint uses [GitHub Actions](https://github.com/features/actions) for automated testing. +## Updating Documentation + +If you open a PR on the Ethermint repo, it is mandatory to update the relevant documentation in `/docs`. Please refer to +the docs subdirectory and make changes accordingly. Prior to approval, the Code owners/approvers may request some +updates to specific docs. + ## Branching Model and Release User-facing repos should adhere to the [trunk based development branching model](https://trunkbaseddevelopment.com/). @@ -173,30 +161,42 @@ Libraries need not follow the model strictly, but would be wise to. Ethermint utilizes [semantic versioning](https://semver.org/). -## PR Targeting +### PR Targeting Ensure that you base and target your PR on the `development` branch. All feature additions should be targeted against `development`. Bug fixes for an outstanding release candidate should be targeted against the release candidate branch. -## Development Procedure +### Pull Requests -1. The latest state of development is on `development`. -2. `development` must never - fail `make lint, make test, make test-race, make test-rpc, make test-solidity, make test-import` -3. No `--force` onto `development` (except when reverting a broken commit, which should seldom happen). -4. Create your feature branch from `development` either on `github.com/cosmos/ethermint`, or your fork ( - using `git remote add origin`). -5. Before submitting a pull request, begin `git rebase` on top of `development`. +To accommodate the review process, we suggest that PRs are categorically broken up. Ideally each PR addresses only a +single issue. Additionally, as much as possible code refactoring and cleanup should be submitted as separate PRs from +bug fixes/feature-additions. + +### Process for reviewing PRs + +All PRs require two Reviews before merge. When reviewing PRs, please use the following review explanations: + +1. `LGTM` without an explicit approval means that the changes look good, but you haven't pulled down the code, run tests + locally and thoroughly reviewed it. +2. `Approval` through the GH UI means that you understand the code, documentation/spec is updated in the right places, + you have pulled down and tested the code locally. In addition: + * You must think through whether any added code could be partially combined (DRYed) with existing code. + * You must think through any potential security issues or incentive-compatibility flaws introduced by the changes. + * Naming convention must be consistent with the rest of the codebase. + * Code must live in a reasonable location, considering dependency structures (e.g. not importing testing modules in + production code, or including example code modules in production code). + * If you approve of the PR, you are responsible for fixing any of the issues mentioned here. +3. If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review. -## Pull Merge Procedure +### Pull Merge Procedure * Ensure pull branch is rebased on `development`. * Run `make test` to ensure that all tests pass. * Squash merge pull request. -## Release Procedure +### Release Procedure * Start on `development`. * Create the release candidate branch `rc/v*` (going forward known as `RC`) and ensure it's protected against pushing From 5ca228047a9e60793171664fe6071ebb74cf0c1e Mon Sep 17 00:00:00 2001 From: Freddy Li Date: Mon, 1 Feb 2021 14:40:25 -0500 Subject: [PATCH 06/11] minor change --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3aa2aaec9..52d5c128b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,8 +93,9 @@ Please **NO DOT** make Pull Requests from `development`. ## Dependencies -We use [Go 1.15](https://github.com/golang/go/wiki/Modules) Modules to manage dependency versions. The master branch of -every Cosmos repository should just build with `go get`, which means they should be kept up-to-date with their +We use [Go 1.15](https://github.com/golang/go/wiki/Modules) Modules to manage dependency versions. + +The master branch of every Cosmos repository should just build with `go get`, which means they should be kept up-to-date with their dependencies, so we can get away with telling people they can just `go get` our software. Since some dependencies are not under our control, a third party may break our build, in which case we can fall back From ec1044a6bbfd1d53e25d51ac644abb92e1a2a206 Mon Sep 17 00:00:00 2001 From: Freddy Li Date: Mon, 1 Feb 2021 14:43:49 -0500 Subject: [PATCH 07/11] minor change --- CONTRIBUTING.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 52d5c128b..7958697cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,10 +93,10 @@ Please **NO DOT** make Pull Requests from `development`. ## Dependencies -We use [Go 1.15](https://github.com/golang/go/wiki/Modules) Modules to manage dependency versions. +We use [Go 1.15](https://github.com/golang/go/wiki/Modules) Modules to manage dependency versions. -The master branch of every Cosmos repository should just build with `go get`, which means they should be kept up-to-date with their -dependencies, so we can get away with telling people they can just `go get` our software. +The master branch of every Cosmos repository should just build with `go get`, which means they should be kept up-to-date +with their dependencies, so we can get away with telling people they can just `go get` our software. Since some dependencies are not under our control, a third party may break our build, in which case we can fall back on `go mod tidy -v`. @@ -193,27 +193,27 @@ All PRs require two Reviews before merge. When reviewing PRs, please use the fol ### Pull Merge Procedure -* Ensure pull branch is rebased on `development`. -* Run `make test` to ensure that all tests pass. -* Squash merge pull request. +1. Ensure pull branch is rebased on `development`. +2. Run `make test` to ensure that all tests pass. +3. Squash merge pull request. ### Release Procedure -* Start on `development`. -* Create the release candidate branch `rc/v*` (going forward known as `RC`) and ensure it's protected against pushing - from anyone except the release manager/coordinator. No PRs targeting this branch should be merged unless exceptional - circumstances arise. -* On the `RC` branch, prepare a new version section in the `CHANGELOG.md`. All links must be link-ified: - `$ python ./scripts/linkify_changelog.py CHANGELOG.md`. - Copy the entries into a `RELEASE_CHANGELOG.md`. This is needed so the bot knows which entries to add to the release - page on github. -* Kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks). -* If errors are found during the simulation testing, commit the fixes to `development` and create a new `RC` branch ( - making sure to increment the `rcN`). -* After simulation has successfully completed, create the release branch (`release/vX.XX.X`) from the `RC` branch. -* Create a PR to `development` to incorporate the `CHANGELOG.md` updates. -* Tag the release (use `git tag -a`) and create a release in Github. -* Delete the `RC` branches. +1. Start on `development`. +2. Create the release candidate branch `rc/v*` (going forward known as `RC`) and ensure it's protected against pushing + from anyone except the release manager/coordinator. No PRs targeting this branch should be merged unless exceptional + circumstances arise. +3. On the `RC` branch, prepare a new version section in the `CHANGELOG.md`. All links must be link-ified: + `$ python ./scripts/linkify_changelog.py CHANGELOG.md`. + Copy the entries into a `RELEASE_CHANGELOG.md`. This is needed so the bot knows which entries to add to the release + page on github. +4. Kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks). +5. If errors are found during the simulation testing, commit the fixes to `development` and create a new `RC` branch ( + making sure to increment the `rcN`). +6. After simulation has successfully completed, create the release branch (`release/vX.XX.X`) from the `RC` branch. +7. Create a PR to `development` to incorporate the `CHANGELOG.md` updates. +8. Tag the release (use `git tag -a`) and create a release in Github. +9. Delete the `RC` branches. **Note**: ChainSafe’s Ethermint team currently cuts releases on a need to have basis. We will announce a more standardized release schedule as we near production readiness. \ No newline at end of file From 3074e15323366f8b7fb757da02c94b54a0def455 Mon Sep 17 00:00:00 2001 From: Freddy Li Date: Mon, 1 Feb 2021 14:46:18 -0500 Subject: [PATCH 08/11] minor change --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7958697cd..42dc01f96 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -204,7 +204,7 @@ All PRs require two Reviews before merge. When reviewing PRs, please use the fol from anyone except the release manager/coordinator. No PRs targeting this branch should be merged unless exceptional circumstances arise. 3. On the `RC` branch, prepare a new version section in the `CHANGELOG.md`. All links must be link-ified: - `$ python ./scripts/linkify_changelog.py CHANGELOG.md`. + `$ python ./scripts/linkify_changelog.py CHANGELOG.md` Copy the entries into a `RELEASE_CHANGELOG.md`. This is needed so the bot knows which entries to add to the release page on github. 4. Kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks). From 705fd848f46600f7bcc7e0005902f0086b64044c Mon Sep 17 00:00:00 2001 From: Colin <44817566+ColinSchwarz@users.noreply.github.com> Date: Mon, 1 Feb 2021 17:26:44 -0500 Subject: [PATCH 09/11] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42dc01f96..bd93f1792 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Ethermint uses [Tendermint’s coding repo](https://github.com/tendermint/coding workflow and standards. Contributing to this repo can mean many things such as participating in discussion or proposing code changes. To ensure -a smooth workflow for all contributors, the general procedure for contributing has been established. +a smooth workflow for all contributors, the following general procedure for contributing has been established: 1. Either [open](https://github.com/cosmos/cosmos-sdk/issues/new/choose) or [find](https://github.com/cosmos/cosmos-sdk/issues) an issue you have identified and would like to contribute to @@ -216,4 +216,4 @@ All PRs require two Reviews before merge. When reviewing PRs, please use the fol 9. Delete the `RC` branches. **Note**: ChainSafe’s Ethermint team currently cuts releases on a need to have basis. We will announce a more -standardized release schedule as we near production readiness. \ No newline at end of file +standardized release schedule as we near production readiness. From 88d7b3e5d7ba8359ba94d18802f9ec13a8e98f9b Mon Sep 17 00:00:00 2001 From: Colin <44817566+ColinSchwarz@users.noreply.github.com> Date: Mon, 1 Feb 2021 17:31:31 -0500 Subject: [PATCH 10/11] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd93f1792..afcbf876f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,18 +37,18 @@ a smooth workflow for all contributors, the following general procedure for cont community of your intentions to begin work. Ideally, wait for confirmation that no one has started it. However, if you are eager and do not get a prompt response, feel free to dive on in! 4. Follow standard Github best practices: - 1. fork the repo - 2. branch from the HEAD of `development`(For core developers working within the cosmos-sdk repo, to ensure a + 1. Fork the repo + 2. Branch from the HEAD of `development`(For core developers working within the cosmos-sdk repo, to ensure a clear ownership of branches, branches must be named with the convention `{moniker}/{issue#}-branch-name`). - 3. make commits - 4. submit a PR to `development` + 3. Make commits + 4. Submit a PR to `development` 5. Be sure to submit the PR in `Draft` mode. Submit your PR early, even if it's incomplete as this indicates to the community you're working on something and allows them to provide comments early in the development process. 6. When the code is complete it can be marked `Ready for Review`. 7. Be sure to include a relevant change log entry in the `Unreleased` section of `CHANGELOG.md` (see file for log format). 8. Please make sure to run `make format` before every commit - the easiest way to do this is having your editor run - it for you upon saving a file. Additionally please ensure that your code is lint compliant by running `make lint` + it for you upon saving a file. Additionally, please ensure that your code is lint compliant by running `make lint` . There are CI tests built into the Ethermint repository and all PR’s will require that these tests pass before they are able to be merged. From ae41f51db65376ce5589b2c4f5b2b0aa3e6661f3 Mon Sep 17 00:00:00 2001 From: Colin <44817566+ColinSchwarz@users.noreply.github.com> Date: Mon, 1 Feb 2021 17:34:58 -0500 Subject: [PATCH 11/11] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afcbf876f..3e05e2a03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,7 +61,7 @@ some [good first issues](https://github.com/cosmos/ethermint/issues?q=label%3A%2 ## Architecture Decision Records (ADR) -When proposing an architecture decision for the SDK, please create +When proposing an architecture decision for Ethermint, please create an [ADR](https://github.com/cosmos/ethermint/blob/development/docs/architecture/README.md) so further discussions can be made. We are following this process so all involved parties are in agreement before any party begins coding the proposed implementation. If you would like to see some examples of how these are written refer @@ -104,7 +104,7 @@ on `go mod tidy -v`. ## Protobuf We use [Protocol Buffers](https://developers.google.com/protocol-buffers) along -with [gogoproto](https://github.com/gogo/protobuf) to generate code for use in Cosmos-SDK. +with [gogoproto](https://github.com/gogo/protobuf) to generate code for use in Ethermint. For deterministic behavior around Protobuf tooling, everything is containerized using Docker. Make sure to have Docker installed on your machine, or head to [Docker's website](https://docs.docker.com/get-docker/) to install it.