From 0bf7ed6e5fd7cf209d16e00861de0688944cc3f2 Mon Sep 17 00:00:00 2001 From: Rootul P Date: Wed, 26 Jul 2023 10:15:18 -0400 Subject: [PATCH 1/2] docs: describe expected branch workflow --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b2a71d5f7f..c0bc53030c 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,8 @@ make proto-gen The canonical branches in this repo are based on CometBFT releases. For example: [`v0.34.x-celestia`](https://github.com/celestiaorg/celestia-core/tree/v0.34.x-celestia) is based on the CometBFT `v0.34.x` release branch and contains Celestia-specific changes. +Usually PRs should target the `main` branch. After the PR merges to main, a maintainer may cherry-pick it to an existing release branch (e.g. [`v0.34.x-celestia`](https://github.com/celestiaorg/celestia-core/tree/v0.34.x-celestia)) and cut a new release. + ## Versioning Releases are formatted: `v-tm-v` From 9e01b05ebdf463ad31a917cc06de753f4e5bf7f9 Mon Sep 17 00:00:00 2001 From: Rootul P Date: Thu, 27 Jul 2023 12:32:14 -0400 Subject: [PATCH 2/2] note about non-breaking changes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c0bc53030c..86f183a5de 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ make proto-gen The canonical branches in this repo are based on CometBFT releases. For example: [`v0.34.x-celestia`](https://github.com/celestiaorg/celestia-core/tree/v0.34.x-celestia) is based on the CometBFT `v0.34.x` release branch and contains Celestia-specific changes. -Usually PRs should target the `main` branch. After the PR merges to main, a maintainer may cherry-pick it to an existing release branch (e.g. [`v0.34.x-celestia`](https://github.com/celestiaorg/celestia-core/tree/v0.34.x-celestia)) and cut a new release. +Usually PRs should target the `main` branch. After the PR merges to main, if the PR contained non-breaking changes, a maintainer may cherry-pick it to an existing release branch (e.g. [`v0.34.x-celestia`](https://github.com/celestiaorg/celestia-core/tree/v0.34.x-celestia)) and cut a new release. ## Versioning