|
5 | 5 | - We follow [Semantic Versioning (semver)](https://semver.org/).
|
6 | 6 | - Cluster API release cadence is Kubernetes Release + 6 weeks.
|
7 | 7 | - The cadence is subject to change if necessary, refer to the [Milestones](https://github.com/kubernetes-sigs/cluster-api/milestones) page for up-to-date information.
|
8 |
| -- The _master_ branch is where development happens, this might include breaking changes. |
| 8 | +- The _main_ branch is where development happens, this might include breaking changes. |
9 | 9 | - The _release-X_ branches contain stable, backward compatible code. A new _release-X_ branch is created at every major (X) release.
|
10 | 10 |
|
11 | 11 | ## Overview
|
@@ -36,11 +36,11 @@ that we follow.
|
36 | 36 |
|
37 | 37 | ## Branches
|
38 | 38 |
|
39 |
| -Cluster API contains two types of branches: the *master* branch and |
| 39 | +Cluster API contains two types of branches: the *main* branch and |
40 | 40 | *release-X* branches.
|
41 | 41 |
|
42 |
| -The *master* branch is where development happens. All the latest and |
43 |
| -greatest code, including breaking changes, happens on master. |
| 42 | +The *main* branch is where development happens. All the latest and |
| 43 | +greatest code, including breaking changes, happens on main. |
44 | 44 |
|
45 | 45 | The *release-X* branches contain stable, backwards compatible code. Every
|
46 | 46 | major (X) release, a new such branch is created. It is from these
|
@@ -109,11 +109,11 @@ Refer to the [releasing document](./docs/developer/releasing.md) for the exact s
|
109 | 109 |
|
110 | 110 | Try to avoid breaking changes. They make life difficult for users, who
|
111 | 111 | have to rewrite their code when they eventually upgrade, and for
|
112 |
| -maintainers/contributors, who have to deal with differences between master |
| 112 | +maintainers/contributors, who have to deal with differences between main |
113 | 113 | and stable branches.
|
114 | 114 |
|
115 | 115 | That being said, we'll occasionally want to make breaking changes. They'll
|
116 |
| -be merged onto master, and will then trigger a major release (see [Release |
| 116 | +be merged onto main, and will then trigger a major release (see [Release |
117 | 117 | Process](#release-process)). Because breaking changes induce a major
|
118 | 118 | revision, the maintainers may delay a particular breaking change until
|
119 | 119 | a later date when they are ready to make a major revision with a few
|
@@ -145,7 +145,7 @@ Development branches:
|
145 | 145 | changes (we still have to merge/manage multiple branches for development
|
146 | 146 | and stable)
|
147 | 147 |
|
148 |
| -- can be confusing to contributors, who often expect master to have the |
| 148 | +- can be confusing to contributors, who often expect main to have the |
149 | 149 | latest changes.
|
150 | 150 |
|
151 | 151 | ### Never break compatibility
|
|
0 commit comments