From 38c65f036c711b68c89cc7c2e15c9dd8a4e0b357 Mon Sep 17 00:00:00 2001 From: Christopher Goes Date: Wed, 15 Aug 2018 15:51:01 +0200 Subject: [PATCH 1/4] Update PR template --- .github/PULL_REQUEST_TEMPLATE.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f7e2d0fd6..060a9f2e3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,12 +4,18 @@ v Before smashing the submit button please review the checkboxes. v If a checkbox is n/a - please still include it but + a little note why ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --> +- Targeted PR against correct branch + - `release/vxx.yy.zz` for a merge into a release candidate + - `master` for a merge of a release + - `develop` in the usual case + - [ ] Linked to github-issue with discussion and accepted design OR link to spec that describes this work. - [ ] Updated all relevant documentation (`docs/`) - [ ] Updated all relevant code comments - [ ] Wrote tests - [ ] Added entries in `PENDING.md` that include links to the relevant issue or PR that most accurately describes the change. - [ ] Updated `cmd/gaia` and `examples/` + ___________________________________ For Admin Use: - [ ] Added appropriate labels to PR (ex. wip, ready-for-review, docs) From 8afacac99d164336bbfe763de47a0451e8acdc6e Mon Sep 17 00:00:00 2001 From: Christopher Goes Date: Wed, 15 Aug 2018 15:53:41 +0200 Subject: [PATCH 2/4] Remove extra space --- .github/PULL_REQUEST_TEMPLATE.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 060a9f2e3..76ccb0d6b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,7 +4,7 @@ v Before smashing the submit button please review the checkboxes. v If a checkbox is n/a - please still include it but + a little note why ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --> -- Targeted PR against correct branch +- Targeted PR against correct branch: - `release/vxx.yy.zz` for a merge into a release candidate - `master` for a merge of a release - `develop` in the usual case @@ -15,7 +15,6 @@ v If a checkbox is n/a - please still include it but + a little note why - [ ] Wrote tests - [ ] Added entries in `PENDING.md` that include links to the relevant issue or PR that most accurately describes the change. - [ ] Updated `cmd/gaia` and `examples/` - ___________________________________ For Admin Use: - [ ] Added appropriate labels to PR (ex. wip, ready-for-review, docs) From 97ae9632bafcb1c836f7d63b2d96422946e62900 Mon Sep 17 00:00:00 2001 From: Christopher Goes Date: Wed, 22 Aug 2018 16:10:57 +0200 Subject: [PATCH 3/4] Move to CONTRIBUTING.md --- .github/PULL_REQUEST_TEMPLATE.md | 5 +---- CONTRIBUTING.md | 7 +++++++ 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 76ccb0d6b..5b7c7d6dc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,10 +4,7 @@ v Before smashing the submit button please review the checkboxes. v If a checkbox is n/a - please still include it but + a little note why ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --> -- Targeted PR against correct branch: - - `release/vxx.yy.zz` for a merge into a release candidate - - `master` for a merge of a release - - `develop` in the usual case +- Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/cosmos-sdk/blob/develop/CONTRIBUTING.md#pr-targeting)) - [ ] Linked to github-issue with discussion and accepted design OR link to spec that describes this work. - [ ] Updated all relevant documentation (`docs/`) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b7ad81fd..e1a5e7c1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -133,6 +133,13 @@ Libraries need not follow the model strictly, but would be wise to. The SDK utilizes [semantic versioning](https://semver.org/). +### PR Targeting + +Ensure that you base and target your PR on the correct branch: + - `release/vxx.yy.zz` for a merge into a release candidate + - `master` for a merge of a release + - `develop` in the usual case + ### Development Procedure: - the latest state of development is on `develop` - `develop` must never fail `make test` or `make test_cli` From addd93b3e532111060f075e57439284cd313b45f Mon Sep 17 00:00:00 2001 From: Christopher Goes Date: Thu, 23 Aug 2018 15:30:29 +0200 Subject: [PATCH 4/4] Add info on what PRs should be targeted where --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1a5e7c1f..3a7dca210 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -140,6 +140,10 @@ Ensure that you base and target your PR on the correct branch: - `master` for a merge of a release - `develop` in the usual case +All feature additions should be targeted against `develop`. Bug fixes for an outstanding release candidate +should be targeted against the release candidate branch. Release candidate branches themselves should be the +only pull requests targeted directly against master. + ### Development Procedure: - the latest state of development is on `develop` - `develop` must never fail `make test` or `make test_cli`