Skip to content

Commit 7eac8da

Browse files
authored
Update our release version number documentation (#6995)
1 parent d8a8e2b commit 7eac8da

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

contributing/versions.md

+7-13
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Versions and releases
22

3-
MDC's version numbers strictly follow [semantic versioning](http://semver.org/):
3+
MDC's version numbers strictly follow [semantic versioning v2.0.0](https://semver.org/spec/v2.0.0.html):
44
`MAJOR.minor.patch`. In short, if the current version is `1.1.1`, then:
55

66
* A major release has a version number of `2.0.0`.
@@ -13,23 +13,17 @@ MDC's version numbers strictly follow [semantic versioning](http://semver.org/):
1313
1414
Major releases can contain breaking changes to clients, while minor and patch releases cannot.
1515

16-
## What are breaking changes?
16+
## How do we determine which numbers need to change?
1717

18-
- API deletions or modifications.
19-
- Visible changes to user interface components.
18+
We follow the guidelines defined by the [semver v2.0.0](https://semver.org/spec/v2.0.0.html#semantic-versioning-specification-semver) specification.
2019

21-
## What are non-breaking changes?
20+
Our public API includes the following:
2221

23-
- API additions.
24-
- Behavioral changes.
22+
- APIs that are present in non-private headers. A private header is one that is contained within a sub-directory named `private/` within a `src/` directory.
2523

26-
## How can a release be a patch release?
24+
We define "backwards incompatible changes" to include the following:
2725

28-
Either:
29-
30-
- There are *no changes to component sources* (changes to documentation—README.md or
31-
header docs—do not count), or
32-
- Component changes *only include bug fixes with no apparent behavioral changes*.
26+
- Any change that will result in a build breakage from the previous release.
3327

3428
## What is the source of truth for MDC's version number?
3529

0 commit comments

Comments
 (0)