From 51a91cde2f5d2be48eb079c9dca416b31b224c43 Mon Sep 17 00:00:00 2001 From: Jack Zampolin Date: Mon, 12 Nov 2018 14:23:29 -0800 Subject: [PATCH 01/10] Update contribuiting.md with new merge policy --- CONTRIBUTING.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3a7dca210edf..055eb3e3f98d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,40 +1,40 @@ # Contributing Thank you for considering making contributions to Cosmos-SDK and related -repositories! +repositories! Contributing to this repo can mean many things such as participated in discussion or proposing code changes. To ensure a smooth workflow for all contributors, the 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'd like to help with, - 2. participate in thoughtful discussion on that issue, + [find](https://github.com/cosmos/cosmos-sdk/issues) an issue you'd like to help with, + 2. participate in thoughtful discussion on that issue, 3. if you would then like to contribute code: - 1. if a the issue is a proposal, ensure that the proposal has been accepted, + 1. if a the issue is a proposal, ensure that the proposal has been accepted, 2. ensure that nobody else has already begun working on this issue, if they have - make sure to contact them to collaborate, + make sure to contact them 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, + to begin work, 4. follow standard github best practices: fork the repo, branch from the - tip of `develop`, make some commits, and submit a PR to `develop`, + tip of `develop`, make some commits, and submit a PR to `develop`, 5. include `WIP:` in the PR-title to and submit your PR early, even if it's incomplete, this indicates to the community you're working on something and allows them to provide comments early in the development process. When the code is complete it can be marked as ready-for-review by replacing `WIP:` with - `R4R:` in the PR-title. + `R4R:` in the PR-title. -Note that for very small or blatantly obvious problems (such as typos) it is +Note that for very small or blatantly obvious problems (such as typos) it is not required to an open 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. +taken place in a github issue, that PR runs a high likelihood of being rejected. Take a peek at our [coding repo](https://github.com/tendermint/coding) for overall information on repository workflow and standards. Note, we use `make get_dev_tools` and `make update_dev_tools` for installing the linting tools. -Other notes: +Other notes: - Looking for a good place to start contributing? How about checking out some [good first issues](https://github.com/cosmos/cosmos-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) @@ -44,9 +44,16 @@ Other notes: ## Pull Requests -To accommodate review process we suggest that PRs are categorically broken up. +To accommodate 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 a separate PRs from bugfixes/feature-additions. +code refactoring and cleanup should be submitted as a separate PRs from bugfixes/feature-additions. + +### Process for Reviewing PRs + +All PRs require 2 Reviews before merge. When reviewing PRs please use the following annotations: + +- `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. +- `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. ## Forking From 7d13028bfa6271aab7fe2a73d083cff54a0c6fbd Mon Sep 17 00:00:00 2001 From: Jack Zampolin Date: Mon, 12 Nov 2018 14:36:12 -0800 Subject: [PATCH 02/10] Add note about documentation updates --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 055eb3e3f98d..b1908c7cb565 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,6 +55,16 @@ All PRs require 2 Reviews before merge. When reviewing PRs please use the follow - `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. - `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. +### A note on Documentation updates + + +If you open a PR on the Cosmos SDK, it is mandatory to update the relevant documentation in /docs. + +* If your change relates to the core SDK (baseapp, store, ...), please update the docs/gaia folder, the docs/examples folder and possibly the docs/spec folder. +* If your changes relate specifically to the gaia application (not including modules), please modify the docs/gaia folder. +* If your changes relate to a module, please update the module's spec in docs/spec. If the module is used by gaia and/or basecoin, you might also need to modify docs/gaia and/or docs/examples. +* If your changes relate to the core of the CLI or Light-client (not specifically to module's CLI/Rest), please modify the docs/clients folder. + ## Forking Please note that Go requires code to live under absolute paths, which complicates forking. From 72142a6b00327c8e689806c09f45642268581abe Mon Sep 17 00:00:00 2001 From: Alexander Bezobchuk Date: Mon, 12 Nov 2018 15:58:45 -0800 Subject: [PATCH 03/10] Update CONTRIBUTING.md Co-Authored-By: jackzampolin --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1908c7cb565..866d6ce9c5b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,7 @@ code refactoring and cleanup should be submitted as a separate PRs from bugfixes ### Process for Reviewing PRs -All PRs require 2 Reviews before merge. When reviewing PRs please use the following annotations: +All PRs require two reviews before merge. When reviewing PRs please use the following annotations: - `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. - `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. From 4e52ad6f324f3c35762ad94cbb526accb8a138c7 Mon Sep 17 00:00:00 2001 From: Rigel Date: Mon, 12 Nov 2018 15:58:51 -0800 Subject: [PATCH 04/10] Update CONTRIBUTING.md Co-Authored-By: jackzampolin --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 866d6ce9c5b0..3fcd84fd0086 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,7 +55,7 @@ All PRs require two reviews before merge. When reviewing PRs please use the foll - `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. - `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. -### A note on Documentation updates +### A Note on Documentation Updates If you open a PR on the Cosmos SDK, it is mandatory to update the relevant documentation in /docs. From 3804e0a9e62063a4039b6aae9bb61bd94462bee0 Mon Sep 17 00:00:00 2001 From: Jack Zampolin Date: Mon, 12 Nov 2018 16:29:32 -0800 Subject: [PATCH 05/10] Address PR comments --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1908c7cb565..3b7b1748c410 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,14 +50,14 @@ code refactoring and cleanup should be submitted as a separate PRs from bugfixes ### Process for Reviewing PRs -All PRs require 2 Reviews before merge. When reviewing PRs please use the following annotations: +All PRs require 2 Reviews before merge. When reviewing PRs please use the following review explainations: - `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. - `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. +- If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review. ### A note on Documentation updates - If you open a PR on the Cosmos SDK, it is mandatory to update the relevant documentation in /docs. * If your change relates to the core SDK (baseapp, store, ...), please update the docs/gaia folder, the docs/examples folder and possibly the docs/spec folder. From 3b295915bf262ba4311253954ed2cafd9ee05634 Mon Sep 17 00:00:00 2001 From: Jack Zampolin Date: Wed, 14 Nov 2018 10:16:18 -0800 Subject: [PATCH 06/10] Add peer review comment (#2811) --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea74c80fb074..a0ed810b8df0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,6 +54,7 @@ All PRs require 2 Reviews before merge. When reviewing PRs please use the follow - `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. - `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. +- If you sat down with the PR submitter and did a pairing review please note that in the `Approval`, or your PR comments. - If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review. ### A Note on Documentation Updates From c76fb6c25dd581892de300eca468b8597b794c95 Mon Sep 17 00:00:00 2001 From: Jack Zampolin Date: Wed, 14 Nov 2018 10:22:24 -0800 Subject: [PATCH 07/10] Address PR comments --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0ed810b8df0..add3e2606ff8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,12 +48,15 @@ To accommodate 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 a separate PRs from bugfixes/feature-additions. -### Process for Reviewing PRs +### Process for reviewing PRs All PRs require 2 Reviews before merge. When reviewing PRs please use the following review explanations: - `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. -- `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. +- `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 also think through anything which ought to be included but is not + - 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 - If you sat down with the PR submitter and did a pairing review please note that in the `Approval`, or your PR comments. - If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review. From 11ce509517bca18e649e69346d3ef508a7cf215d Mon Sep 17 00:00:00 2001 From: Jack Zampolin Date: Wed, 14 Nov 2018 12:34:18 -0800 Subject: [PATCH 08/10] Address PR comments --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index add3e2606ff8..46016e34fe27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,13 +50,16 @@ code refactoring and cleanup should be submitted as a separate PRs from bugfixes ### Process for reviewing PRs -All PRs require 2 Reviews before merge. When reviewing PRs please use the following review explanations: +All PRs require two Reviews before merge (except docs changes, or variable name-changes which only require one). When reviewing PRs please use the following review explanations: - `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. - `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 also think through anything which ought to be included but is not - 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 must be consistent with conventions and 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 and more - If you sat down with the PR submitter and did a pairing review please note that in the `Approval`, or your PR comments. - If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review. From bbf8cca407a154818a216c3c9a07e2091029f218 Mon Sep 17 00:00:00 2001 From: gamarin2 Date: Wed, 14 Nov 2018 12:46:17 -0800 Subject: [PATCH 09/10] Update CONTRIBUTING.md Co-Authored-By: jackzampolin --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46016e34fe27..752216d4a2d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,7 +63,7 @@ All PRs require two Reviews before merge (except docs changes, or variable name- - If you sat down with the PR submitter and did a pairing review please note that in the `Approval`, or your PR comments. - If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review. -### A Note on Documentation Updates +### Updating docs If you open a PR on the Cosmos SDK, it is mandatory to update the relevant documentation in /docs. From 20b2e075f3fe369bd979edc6b4a3d09e90c2ff9c Mon Sep 17 00:00:00 2001 From: Jack Zampolin Date: Wed, 14 Nov 2018 12:51:10 -0800 Subject: [PATCH 10/10] Address @gamarin's comments --- CONTRIBUTING.md | 2 +- docs/DOCS_README.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 752216d4a2d2..96804e28c8e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,7 +63,7 @@ All PRs require two Reviews before merge (except docs changes, or variable name- - If you sat down with the PR submitter and did a pairing review please note that in the `Approval`, or your PR comments. - If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review. -### Updating docs +### Updating Documentation If you open a PR on the Cosmos SDK, it is mandatory to update the relevant documentation in /docs. diff --git a/docs/DOCS_README.md b/docs/DOCS_README.md index 48a31c2ea929..4ccea82f367b 100644 --- a/docs/DOCS_README.md +++ b/docs/DOCS_README.md @@ -15,6 +15,10 @@ Besides, gaia-lite API docs are also provided by gaia-lite. The default API docs https://localhost:1317/swagger-ui/ ``` +## Updating the Documentation + +Please read the `Updating Documentation` section in [`CONTRIBUTING.md` document](../CONTRIBUTING.MD#updating-documentation) before making any changes. + ## How It Works There is a Jenkins job listening for changes in the `/docs` directory, on both