web/simple-icons
1
0
Fork 0
mirror of https://github.com/simple-icons/simple-icons.git synced 2024-11-26 01:00:27 +02:00
Code Releases Activity
454bb9ae2f
simple-icons/VERSIONING.md
Eric Cornelissen 668c9e49c7
Create VERSIONING.md (#6023) 
* Create VERSIONING.md

* Include VERSIONING.md in NPM package

* Add note on deprecation timelines to VERSIONING.md

* Be explicit about what "support for old major versions" means

Co-authored-by: Peter Noble <petershaggynoble@gmail.com>
2021-09-30 09:33:44 +02:00

1.4 KiB
Raw Blame History

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

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.

Support of a major version entails the following:

  • SVGs and metadata of brands will be updated on request. This excludes brands that were removed in the new major release.
  • Bugs in the npm library will be updated if reported.