| 1 | # Versioning
|
| 2 |
|
| 3 | We use [Semantic Versioning](https://semver.org/) to version Simple Icons. In short, this means that version numbers are structured as `MAJOR.MINOR.PATCH`. For example, version `3.1.4` is major version `3`, minor version `1`, and patch `4`. Increasing each of these numbers implies certain kinds of changes.
|
| 4 |
|
| 5 | For Simple Icons, given a change to the version number you can expect the following kinds of changes:
|
| 6 |
|
| 7 | | Version number increase | Kinds of changes |
|
| 8 | | :---- | :---- |
|
| 9 | | _Major_ | Removed icons; Renamed icons; Breaking API changes |
|
| 10 | | _Minor_ | New icons; API changes |
|
| 11 | | _Patch_ | Updated SVGs; Updated metadata |
|
| 12 |
|
| 13 | ## Release Schedule
|
| 14 |
|
| 15 | _Minor_ releases and _patches_ are scheduled on a weekly basis and are generally released on a Sunday.
|
| 16 |
|
| 17 | _Major_ releases are scheduled on a half-year basis, mainly to remove old SVGs. That is, approximately every 6 months a normal Sunday release is a _major_ release instead of a _minor_ release or _patch_.
|
| 18 |
|
| 19 | ## Deprecation
|
| 20 |
|
| 21 | For approximately 3 months after a _major_ release, the _major_ release preceding it will be supported. After 3 months, the previous _major_ release is deprecated and will no longer be supported.
|
| 22 |
|
| 23 | Support of a _major_ version entails the following:
|
| 24 |
|
| 25 | - SVGs and metadata of brands will be updated on request. This excludes brands that were removed in the new _major_ release.
|
| 26 | - Bugs in the npm library will be updated if reported.
|