Skip to content

Commit aae5670

Browse files
GitHub/contributions: explain backport labelling
1 parent 3df5bff commit aae5670

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

site/github.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,18 +81,28 @@ main (default) branches of the RabbitMQ repositories
8181
of interest.
8282

8383
Pull requests that are meant to ship in currently maintained release series,
84-
for example, 3.11.x, are backported to `v3.11.x`, `v3.10.x` and othe release series
85-
branches after being merged into the `main` branch.
84+
for example, 3.11.x, are backported to release series-specific
85+
branches.
8686

87-
## <a id="maintenance-branches" class="anchor" href="#maintenance-branches">Maintenance branch</a>
87+
## <a id="release-branches" class="anchor" href="#release-branches">Release series branches</a>
8888

89-
There's a separate branch for maintenance work,
90-
named after the current stable release series. Currently it is <code>v3.11.x</code>.
89+
There is also a separate branch for every release series that is currently
90+
maintained. These branches are named after the series: <code>v3.11.x</code>, <code>v3.10.x</code>,
91+
and so on.
9192

9293
It plays the same role as the <code>main</code> branch except that it carries merged,
9394
QA'd code intended for the next bug-fix release rather than
9495
the next general release.
9596

97+
Pull requests that are meant to ship in currently maintained release series are backported
98+
to these branches after being merged into the `main` branch. In the process they are
99+
labelled with `backport-v3.11.x`, `backport-v3.10.x`, and similar labels
100+
on GitHub.
101+
102+
For example, if a pull request is labelled with `backport-v3.10.x`, it means that it was
103+
backported, or at least considered for backporting, to the `v3.10.x` branch to ship
104+
in a 3.10.x release.
105+
96106
## <a id="tags" class="anchor" href="#tags">Tags</a>
97107

98108
Team RabbitMQ uses tags in the git repository to give names to snapshots of the state of
@@ -111,8 +121,6 @@ git tag
111121
# => v3.11.5
112122
</pre>
113123

114-
115-
116124
<pre class="lang-bash">
117125
git checkout v3.11.5
118126
</pre>

0 commit comments

Comments
 (0)