d180d6c7f8
* Update deprecation notice in versioning policy * Update VERSIONING.md Co-authored-by: Adam Rusted <hello@adamrusted.me> * Update VERSIONING.md Co-authored-by: Peter Noble <15157491+PeterShaggyNoble@users.noreply.github.com> * Update VERSIONING.md Co-authored-by: Adam Rusted <hello@adamrusted.me> --------- Co-authored-by: Adam Rusted <hello@adamrusted.me> Co-authored-by: Peter Noble <15157491+PeterShaggyNoble@users.noreply.github.com>
1.2 KiB
Versioning
We use Semantic Versioning 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.
For Simple Icons, given a change to the version number you can expect the following kinds of changes:
| Version number increase | Kinds of changes |
|---|---|
| Major | Removed icons; Renamed icons; Breaking API changes |
| Minor | New icons; API changes |
| Patch | Updated SVGs; Updated metadata |
Release Schedule
Minor releases and patches are scheduled on a weekly basis and are generally released on a Sunday.
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.
Deprecation
After a major release, the only other supported version is the last version of the previous major release. This previous version will only receive bug fixes to either the npm library, or our internal APIs.