DEV/material-components_material-components-ios
1
0
Fork 0
mirror of https://github.com/material-components/material-components-ios.git synced 2026-02-20 08:27:32 +08:00
Code Issues Packages Projects Releases Wiki Activity
material-components_materia.../contributing/versions.md
Adrian Secord 94ef08b343 Updates to release docs (#1079) 
* Updated our releasing docs to reflect current reality.

* Further editing.

* Restored section title to avoid breaking links.
2016-12-15 11:40:21 -05:00

1.1 KiB
Raw Blame History

Versions and releases

MDC's version numbers strictly follow semantic versioning: MAJOR.minor.patch. In short, if the current version is 1.1.1, then:

  • A major release has a version number of 2.0.0.
  • A minor release has a version number of 1.2.0.
  • A patch release has a version number of 1.1.2.

These are engineering version numbers, intended for communicating to our engineering clients what type of follow-up work a upgrading to a release might entail. Since every breaking change bumps the major version number, we'll quickly run up to "large" major versions. That's ok.

Major releases can contain breaking changes to clients, while minor and patch releases cannot.

What are breaking changes?

  • API deletions or modifications.
  • Visible changes to user interface components.

What are non-breaking changes?

  • API additions.
  • Behavioral changes.

How can a release be a patch release?

Either:

  • There are no changes to component sources (changes to documentation—README.md or header docs—do not count), or
  • Component changes only include bug fixes with no apparent behavioral changes.