Add versioning notes to release.md #629
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Versioning and Releases | ||
|
|
||
| Cirq is currently (as of July 11, 2018) alpha, and so has a MAJOR version | ||
| of 0. Below is info on how we version releases, and how the releases | ||
| themselves are created. Note that development is done on the `master` | ||
| branch, so if you want to use a more stable version you should use one | ||
| of the [releases](https://github.com/quantumlib/Cirq/releases) or | ||
| install from pypi. | ||
|
|
||
| ## Versioning | ||
|
|
||
| We follow [semantic versioning](https://semver.org/) for labeling our | ||
| releases. Versions are labeled MAJOR.MINOR.PATCH where each of these | ||
| is a numerical value. The rules for versions changes are: | ||
| * Before MAJOR becomes 1, updates to MINOR can and will make changes to | ||
| public facing apis and interfaces.. | ||
| * After MAJOR becomes 1, updates that break the public facing api | ||
| or interface need to update MAJOR version. | ||
| * MINOR updates have to be backwards compatible (after MAJOR>=1). | ||
| * PATCH updates are for bug fixes. | ||
|
|
||
| ## Releases | ||
|
|
||
| We use github's release system for creating releases. Release are listed | ||
| [on the Cirq release page](https://github.com/quantumlib/Cirq/releases). | ||
|
|
||
| Our development process uses the `master` branch for development. | ||
| When a release is made for a major or minor version update, `master` | ||
|
There was a problem hiding this comment. I would say that a commit is tagged, not master. There was a problem hiding this comment. changed to "a commit to the master branch" |
||
| is tagged with a version tag (vX.X.X) for a pull request corresponding | ||
|
There was a problem hiding this comment. What do you mean by a pull request corresponding to the release? Like, we make a pull request "Release vX", merge it, and the resulting commit is what we tag? |
||
| to the release. In the pull request corresponding to the release | ||
| the [version file](cirq/_version.py) should be updated. After | ||
| that version is cut, a future pull request should update the | ||
| version to the next minor version with `-dev` appended. | ||
|
There was a problem hiding this comment. Might want to do |
||
|
|
||
| For patch version updates (bug fixes), we follow a different pattern. | ||
| For these we create a separate branch that off of the version the | ||
|
|
||
| major minor version for the patch, or a previous branch patch. The | ||
| branches should be of the name `branch-X-X-X` corresponding to the | ||
|
|
||
| version. These can then be appropriately tagged and the release | ||
| pushed to pypi. These fixes, if possible, should also be merged | ||
| into master via a separate change. | ||
|
|
||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Double .
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed