Skip to content

Commit fc1aa3d

Browse files
authored
Update README.md
Add info on version numbers
1 parent 3ed4871 commit fc1aa3d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ Pinhead has no dependencies and is basically just a directory of SVG files. A fe
3636
- `dist/icons/index.complete.json`: same as the above but with the SVG code included inline
3737
- `dist/migrations.json`: a machine-readable list of icon additions, deletions, and renames between major versions
3838

39+
#### Version numbers
40+
41+
Pinhead uses a flavor of semantic versioning, with major releases (v2 etc.) corresponding to breaking changes, minor releases (v2.1) corresponding to backwards-compatible changes, and patch releases (v2.1.1 etc.) corresponding to fixes.
42+
43+
When it comes to icons, renaming or deleting an icon, or making any visual modification, is a breaking change. Perhaps counterintuitively, we also consider the addition of any new icon to be a breaking change. The goal is clear version integrity, where each major version number refers to a complete set of icons with no differences between minor versions. This avoids common gotchas, like developers depending on a library like `^1.0.0` and potentially seeing different lists of icons in development vs. production in the case where v1.1.0 adds an icon.
44+
3945
## Where the icons are from
4046

4147
Pinhead is seeded from the following public domain sources. Thank you to all the contributors who made these projects possible.

0 commit comments

Comments
 (0)