Skip to content

Commit 2a86b0b

Browse files
authored
Reformat docs/design/versioning.md (#2057)
1 parent a9a6121 commit 2a86b0b

File tree

1 file changed

+33
-11
lines changed

1 file changed

+33
-11
lines changed

docs/designs/versioning.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,32 @@
11
# Versioning
22

3-
For better managing and releasing code, here is a summary about the versioning story of ElasticDL. Some previous discussions can be found [here](#1121).
3+
For better managing and releasing code, here is a summary about the versioning
4+
story of ElasticDL. Some previous discussions can be found [here](#1121).
45

56
## Branches
67

78
There are three different type branches:
8-
- **develop** branch: the main branch where the source code always reflects a state with the latest delivered development changes for the next release.
9-
- **feature** branches: branch off from the `develop` branch and merge back into `develop`. `Feature` branches are used to develop new features, and created/maintained by developers themselves. `Feature` branches will be deleted after code changes get merge info `develop` branch.
10-
- **release** branches: branch off from the `develop` branch. When the `develop` branch reaches the desired state of a new release, cut off a new release branch, and start to publish new versions there. Release branches will be kept.
11-
12-
For version numbers, we follow the [Semantic Versioning 2.0.0](https://semver.org/ with style MAJOR.MINOR.PATCH (e.g. 0.2.1). For each MAJOR.MINOR, we keep a corresponding `release` branch (named `branch-x.y`), and each following patch version x.y.z is released from it.
139

10+
- **develop** branch: the main branch where the source code always reflects a
11+
state with the latest delivered development changes for the next release.
12+
- **feature** branches: branch off from the `develop` branch and merge back into
13+
`develop`. `Feature` branches are used to develop new features, and
14+
created/maintained by developers themselves. `Feature` branches will be
15+
deleted after code changes get merge info `develop` branch.
16+
- **release** branches: branch off from the `develop` branch. When the `develop`
17+
branch reaches the desired state of a new release, cut off a new release
18+
branch, and start to publish new versions there. Release branches will be
19+
kept.
20+
21+
For version numbers, we follow the Semantic Versioning
22+
[2.0.0](https://semver.org) with style MAJOR.MINOR.PATCH (e.g. 0.2.1). For each
23+
MAJOR.MINOR, we keep a corresponding `release` branch (named `branch-x.y`), and
24+
each following patch version x.y.z is released from it.
1425

1526
## Feature Development
1627

17-
New features and bugfixes are developed in `feature` branches. Make sure you work with the latest version of `develop` branch.
28+
New features and bugfixes are developed in `feature` branches. Make sure you
29+
work with the latest version of `develop` branch.
1830

1931
```bash
2032
# Start a new feature branch from develop branch
@@ -28,7 +40,9 @@ $ git checkout develop
2840
$ git branch -D feature1
2941
```
3042

31-
Here is the [tutorial](https://help.github.com/en/articles/creating-a-pull-request#changing-the-branch-range-and-destination-repository) on how to open a pull request.
43+
Here is the
44+
[tutorial](https://help.github.com/en/articles/creating-a-pull-request#changing-the-branch-range-and-destination-repository)
45+
on how to open a pull request.
3246

3347
## Releasing
3448

@@ -48,7 +62,11 @@ $ git push origin branch-0.1
4862
# A detailed instruction is available at https://packaging.python.org/tutorials/packaging-projects/
4963
```
5064

51-
So now we have v0.1.0rc0 ready to use. Test out this version. If any issues found, get them fixed in `develop` branch, merged into `branch-0.1` branch, and repeat the aforementioned steps to publish a new release candidate version. We keep releasing `rc` version until no further issues found. At that time, release the official `v0.1.0` version.
65+
So now we have v0.1.0rc0 ready to use. Test out this version. If any issues
66+
found, get them fixed in `develop` branch, merged into `branch-0.1` branch, and
67+
repeat the aforementioned steps to publish a new release candidate version. We
68+
keep releasing `rc` version until no further issues found. At that time, release
69+
the official `v0.1.0` version.
5270

5371
```bash
5472
$ git checkout -b branch-0.1 develop
@@ -61,7 +79,11 @@ $ git push origin branch-0.1
6179
$ git tag v0.1.0 -a
6280
$ git push origin v0.1.0
6381
```
64-
Note that for creating new releases and tags, you can also do from the [website](https://github.com/sql-machine-learning/elasticdl/releases).
6582

83+
Note that for creating new releases and tags, you can also do from the
84+
[website](https://github.com/sql-machine-learning/elasticdl/releases).
6685

67-
For cases where the `release` branch already exists (for example when releasing 0.1.1 and `branch-0.1` is already there), just reuse that `release` branch and merge required commits from `develop` branch to the corresponding `release` branch.
86+
For cases where the `release` branch already exists (for example when releasing
87+
0.1.1 and `branch-0.1` is already there), just reuse that `release` branch and
88+
merge required commits from `develop` branch to the corresponding `release`
89+
branch.

0 commit comments

Comments
 (0)