Mibew/simple-icons
1
0
Fork 0
mirror of https://github.com/Mibew/simple-icons.git synced 2024-11-15 09:54:11 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add documentation on versioning (#2568)

Browse Source 
* Draft documentation on versioning

* Add "Renamed icons" to kinds of changes for a major release

* Change "Updated icons" to "Updated SVGs" & "Updated metadata" for patch
This commit is contained in:
Eric Cornelissen 2020-02-11 00:53:30 +02:00 committed by GitHub
parent f464743a48
commit 3424fd8720
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -165,3 +165,15 @@ Once you've completed the previous steps, create a pull request to merge your ed
Alternatively, you can build and run the website in a readily configured online workspace: Alternatively, you can build and run the website in a readily configured online workspace:
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/simple-icons/simple-icons) [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/simple-icons/simple-icons)
---
# Versioning
We use [Semantic Versioning](https://semver.org/) in this project. Given a version number `MAJOR.MINOR.PATCH` you can expect the following kinds of changes:
| Version number | Kinds of changes |
| :---- | :---- |
| _Major_ | Removed icons; Renamed icons; Breaking API changes |
| _Minor_ | New icons; API changes |
| _Patch_ | Updated SVGs; Updated metadata |